Bonmin  1.7
Public Member Functions | Private Attributes
Bonmin::IpoptWarmStart Class Reference

Class for storing warm start informations for Ipopt. More...

#include <BonIpoptWarmStart.hpp>

List of all members.

Public Member Functions

 IpoptWarmStart (bool empty=1, int numvars=0, int numcont=0)
 Default constructor.
 IpoptWarmStart (const Ipopt::SmartPtr< TMINLP2TNLP > tnlp, Ipopt::SmartPtr< IpoptInteriorWarmStarter > warm_starter)
 Usefull constructor, stores the current optimum of ipopt.
 IpoptWarmStart (int primal_size, int dual_size, const double *primal, const double *dual)
 Another usefull constructor, stores the passed point.
 IpoptWarmStart (const IpoptWarmStart &other, bool ownValues=1)
 Copy constructor.
 IpoptWarmStart (const CoinWarmStartPrimalDual &pdws)
 A constructor from a CoinWarmStartPrimalDual.
virtual ~IpoptWarmStart ()
 Abstract destructor.
virtual CoinWarmStart * clone () const
 `Virtual constructor'
virtual CoinWarmStartDiff * generateDiff (const CoinWarmStart *const oldCWS) const
 Generate the "differences" between two IpoptWarmStart.
virtual void applyDiff (const CoinWarmStartDiff *const cwsdDiff)
 Apply 'differences' to an Ipopt warm start.
Ipopt::SmartPtr
< IpoptInteriorWarmStarter
warm_starter () const
 Accessor to warm start information obecjt.
void flushPoint ()
 flush the starting point
bool empty () const
 Is this an empty warm start?

Private Attributes

Ipopt::SmartPtr
< IpoptInteriorWarmStarter
warm_starter_
 warm start information object
bool empty_
 Say if warm start is empty.

Detailed Description

Class for storing warm start informations for Ipopt.


This class inherits from CoinWarmStartPrimalDual, because that's what this warmstart really is.
For practical reason (integration in Cbc) this class also inherits from CoinWarmStartBasis.
This class stores a starting point (primal and dual values) for Ipopt.

The primal part of the base class contains the value of each primal variable.

The dual part of the base class consists of three sections (the number of values is 2*numcols+numrows):

Definition at line 46 of file BonIpoptWarmStart.hpp.


Constructor & Destructor Documentation

Bonmin::IpoptWarmStart::IpoptWarmStart ( bool  empty = 1,
int  numvars = 0,
int  numcont = 0 
)

Default constructor.

Referenced by clone().

Bonmin::IpoptWarmStart::IpoptWarmStart ( const Ipopt::SmartPtr< TMINLP2TNLP tnlp,
Ipopt::SmartPtr< IpoptInteriorWarmStarter warm_starter 
)

Usefull constructor, stores the current optimum of ipopt.

Bonmin::IpoptWarmStart::IpoptWarmStart ( int  primal_size,
int  dual_size,
const double *  primal,
const double *  dual 
)

Another usefull constructor, stores the passed point.

Bonmin::IpoptWarmStart::IpoptWarmStart ( const IpoptWarmStart other,
bool  ownValues = 1 
)

Copy constructor.

Bonmin::IpoptWarmStart::IpoptWarmStart ( const CoinWarmStartPrimalDual &  pdws)

A constructor from a CoinWarmStartPrimalDual.

virtual Bonmin::IpoptWarmStart::~IpoptWarmStart ( ) [virtual]

Abstract destructor.


Member Function Documentation

virtual CoinWarmStart* Bonmin::IpoptWarmStart::clone ( ) const [inline, virtual]

`Virtual constructor'

Definition at line 67 of file BonIpoptWarmStart.hpp.

References IpoptWarmStart().

virtual CoinWarmStartDiff* Bonmin::IpoptWarmStart::generateDiff ( const CoinWarmStart *const  oldCWS) const [virtual]

Generate the "differences" between two IpoptWarmStart.

virtual void Bonmin::IpoptWarmStart::applyDiff ( const CoinWarmStartDiff *const  cwsdDiff) [virtual]

Apply 'differences' to an Ipopt warm start.

What this actually does is get a copy to the vector of values stored in IpoptWarmStartDiff.

Ipopt::SmartPtr<IpoptInteriorWarmStarter> Bonmin::IpoptWarmStart::warm_starter ( ) const [inline]

Accessor to warm start information obecjt.

Definition at line 82 of file BonIpoptWarmStart.hpp.

References warm_starter_.

void Bonmin::IpoptWarmStart::flushPoint ( )

flush the starting point

bool Bonmin::IpoptWarmStart::empty ( ) const [inline]

Is this an empty warm start?

Definition at line 91 of file BonIpoptWarmStart.hpp.

References empty_.


Member Data Documentation

warm start information object

Definition at line 97 of file BonIpoptWarmStart.hpp.

Referenced by warm_starter().

Say if warm start is empty.

Definition at line 99 of file BonIpoptWarmStart.hpp.

Referenced by empty().


The documentation for this class was generated from the following file: