IpoptWarmStart Class Reference

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

#include <IpoptWarmStart.hpp>

Inheritance diagram for IpoptWarmStart:

Inheritance graph
[legend]
Collaboration diagram for IpoptWarmStart:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 IpoptWarmStart (bool empty=1, int numvars=0, int numcont=0)
 Default constructor.
 IpoptWarmStart (const IpoptInterface &ipopt, SmartPtr< IpoptInteriorWarmStarter > warm_starter)
 Usefull constructor, stores the current optimum of ipopt.
 IpoptWarmStart (const IpoptWarmStart &other, bool ownValues=1)
 Copy constructor.
virtual ~IpoptWarmStart ()
 Abstract destructor.
virtual CoinWarmStartclone () const
 `Virtual constructor'
virtual CoinWarmStartDiffgenerateDiff (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.
const CoinPackedVectorvalues () const
 Access to values_ vector.
SmartPtr< IpoptInteriorWarmStarterwarm_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

CoinPackedVector values_
 Non zero values of the starting point.
CoinPackedVectortempValues_
 Temporary values not owned by this.
SmartPtr< IpoptInteriorWarmStarterwarm_starter_
 warm start information object
bool empty_
 Say if warm start is empty.

Detailed Description

Class for storing warm start informations for Ipopt.


For practical reason (integration in Cbc) this class inherits from CoinWarmStartBasis.
This class stores a starting point (primal and dual values) for Ipopt.

Definition at line 25 of file IpoptWarmStart.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Referenced by clone().

IpoptWarmStart::IpoptWarmStart ( const IpoptInterface ipopt,
SmartPtr< IpoptInteriorWarmStarter warm_starter 
)

Usefull constructor, stores the current optimum of ipopt.

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

Copy constructor.

virtual IpoptWarmStart::~IpoptWarmStart (  )  [virtual]

Abstract destructor.


Member Function Documentation

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

`Virtual constructor'

Reimplemented from CoinWarmStartBasis.

Definition at line 40 of file IpoptWarmStart.hpp.

References IpoptWarmStart().

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

Generate the "differences" between two IpoptWarmStart.

Reimplemented from CoinWarmStartBasis.

virtual void 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.

Reimplemented from CoinWarmStartBasis.

const CoinPackedVector* IpoptWarmStart::values (  )  const [inline]

Access to values_ vector.

Definition at line 54 of file IpoptWarmStart.hpp.

References tempValues_, and values_.

Referenced by IpoptWarmStartDiff::IpoptWarmStartDiff().

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

Accessor to warm start information obecjt.

Definition at line 62 of file IpoptWarmStart.hpp.

References warm_starter_.

void IpoptWarmStart::flushPoint (  ) 

flush the starting point

bool IpoptWarmStart::empty (  )  const [inline]

Is this an empty warm start?

Definition at line 71 of file IpoptWarmStart.hpp.

References empty_.


Member Data Documentation

CoinPackedVector IpoptWarmStart::values_ [mutable, private]

Non zero values of the starting point.

Primal and dual values are stored in the following order

Definition at line 84 of file IpoptWarmStart.hpp.

Referenced by values().

CoinPackedVector* IpoptWarmStart::tempValues_ [mutable, private]

Temporary values not owned by this.

Definition at line 86 of file IpoptWarmStart.hpp.

Referenced by values().

SmartPtr<IpoptInteriorWarmStarter> IpoptWarmStart::warm_starter_ [mutable, private]

warm start information object

Definition at line 88 of file IpoptWarmStart.hpp.

Referenced by warm_starter().

bool IpoptWarmStart::empty_ [private]

Say if warm start is empty.

Definition at line 90 of file IpoptWarmStart.hpp.

Referenced by empty().


The documentation for this class was generated from the following file:
Generated on Fri May 16 21:15:14 2008 for Bonmin by  doxygen 1.4.7