Cbc  2.9.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
AbcWarmStart Class Reference

As CoinWarmStartBasis but with alternatives (Also uses Clp status meaning for slacks) More...

#include <AbcWarmStart.hpp>

+ Inheritance diagram for AbcWarmStart:
+ Collaboration diagram for AbcWarmStart:

Public Member Functions

Methods to modify the warm start object
virtual void setSize (int ns, int na)
 Set basis capacity; existing basis is discarded. More...
 
virtual void resize (int newNumberRows, int newNumberColumns)
 Set basis capacity; existing basis is maintained. More...
 
virtual void compressRows (int tgtCnt, const int *tgts)
 Delete a set of rows from the basis. More...
 
virtual void deleteRows (int rawTgtCnt, const int *rawTgts)
 Delete a set of rows from the basis. More...
 
virtual void deleteColumns (int number, const int *which)
 Delete a set of columns from the basis. More...
 
void setModel (AbcSimplex *model)
 Set model. More...
 
AbcSimplexmodel () const
 Get model. More...
 
void createBasis0 (const AbcSimplex *model)
 Create Basis type 0. More...
 
void createBasis12 (const AbcSimplex *model)
 Create Basis type 12. More...
 
void createBasis34 (const AbcSimplex *model)
 Create Basis type 34. More...
 
Constructors, destructors, and related functions
 AbcWarmStart ()
 Default constructor. More...
 
 AbcWarmStart (AbcSimplex *model, int type)
 Constructs a warm start object with the specified status vectors. More...
 
 AbcWarmStart (const AbcWarmStart &ws)
 Copy constructor. More...
 
virtual CoinWarmStartclone () const
 `Virtual constructor' More...
 
virtual ~AbcWarmStart ()
 Destructor. More...
 
virtual AbcWarmStartoperator= (const AbcWarmStart &rhs)
 Assignment. More...
 
virtual void assignBasisStatus (int ns, int na, char *&sStat, char *&aStat)
 Assign the status vectors to be the warm start information. More...
 
- Public Member Functions inherited from CoinWarmStartBasis
int getNumStructural () const
 Return the number of structural variables. More...
 
int getNumArtificial () const
 Return the number of artificial variables. More...
 
int numberBasicStructurals () const
 Return the number of basic structurals. More...
 
Status getStructStatus (int i) const
 Return the status of the specified structural variable. More...
 
void setStructStatus (int i, Status st)
 Set the status of the specified structural variable. More...
 
char * getStructuralStatus ()
 Return the status array for the structural variables. More...
 
const char * getStructuralStatus () const
 const overload for getStructuralStatus() More...
 
char * getArtificialStatus ()
 As for getStructuralStatus , but returns the status array for the artificial variables. More...
 
Status getArtifStatus (int i) const
 Return the status of the specified artificial variable. More...
 
void setArtifStatus (int i, Status st)
 Set the status of the specified artificial variable. More...
 
const char * getArtificialStatus () const
 const overload for getArtificialStatus() More...
 
virtual CoinWarmStartDiffgenerateDiff (const CoinWarmStart *const oldCWS) const
 Generate a `diff' that can convert the warm start basis passed as a parameter to the warm start basis specified by this. More...
 
virtual void applyDiff (const CoinWarmStartDiff *const cwsdDiff)
 Apply diff to this basis. More...
 
virtual void mergeBasis (const CoinWarmStartBasis *src, const XferVec *xferRows, const XferVec *xferCols)
 Merge entries from a source basis into this basis. More...
 
 CoinWarmStartBasis ()
 Default constructor. More...
 
 CoinWarmStartBasis (int ns, int na, const char *sStat, const char *aStat)
 Constructs a warm start object with the specified status vectors. More...
 
 CoinWarmStartBasis (const CoinWarmStartBasis &ws)
 Copy constructor. More...
 
virtual ~CoinWarmStartBasis ()
 Destructor. More...
 
virtual CoinWarmStartBasisoperator= (const CoinWarmStartBasis &rhs)
 Assignment. More...
 
virtual void print () const
 Prints in readable format (for debug) More...
 
bool fullBasis () const
 Returns true if full basis (for debug) More...
 
bool fixFullBasis ()
 Returns true if full basis and fixes up (for debug) More...
 
- Public Member Functions inherited from CoinWarmStart
virtual ~CoinWarmStart ()
 Abstract destructor. More...
 

Protected Attributes

Protected data members
int typeExtraInformation_
 
Type of basis (always status arrays)

0 - as CoinWarmStartBasis 1,2 - plus factor order as shorts or ints (top bit set means column) 3,4 - plus compact saved factorization add 8 to say steepest edge weights stored (as floats) may want to change next,previous to tree info so can use a different basis for weights More...

 
int lengthExtraInformation_
 Length of extra information in bytes. More...
 
char * extraInformation_
 The extra information. More...
 
AbcSimplexmodel_
 Pointer back to AbcSimplex (can only be applied to that) More...
 
AbcWarmStartOrganizerorganizer_
 Pointer back to AbcWarmStartOrganizer for organization. More...
 
AbcWarmStartpreviousBasis_
 Pointer to previous basis. More...
 
AbcWarmStartnextBasis_
 Pointer to next basis. More...
 
int stamp_
 Sequence stamp for deletion. More...
 
int numberValidRows_
 Number of valid rows (rest should have slacks) Check to see if weights are OK for these rows and then just btran new ones for weights. More...
 
- Protected Attributes inherited from CoinWarmStartBasis
int numStructural_
 The number of structural variables. More...
 
int numArtificial_
 The number of artificial variables. More...
 
int maxSize_
 The maximum sise (in ints - actually 4*char) (so resize does not need to do new) More...
 
char * structuralStatus_
 The status of the structural variables. More...
 
char * artificialStatus_
 The status of the artificial variables. More...
 

Additional Inherited Members

- Public Types inherited from CoinWarmStartBasis
enum  Status { isFree = 0x00, basic = 0x01, atUpperBound = 0x02, atLowerBound = 0x03 }
 Enum for status of variables. More...
 
typedef CoinTriple< int, int, int > XferEntry
 Transfer vector entry for mergeBasis(const CoinWarmStartBasis*,const XferVec*,const XferVec*) More...
 
typedef std::vector< XferEntryXferVec
 Transfer vector for mergeBasis(const CoinWarmStartBasis*,const XferVec*,const XferVec*) More...
 

Detailed Description

As CoinWarmStartBasis but with alternatives (Also uses Clp status meaning for slacks)

Definition at line 75 of file AbcWarmStart.hpp.

Constructor & Destructor Documentation

AbcWarmStart::AbcWarmStart ( )

Default constructor.

Creates a warm start object representing an empty basis (0 rows, 0 columns).

AbcWarmStart::AbcWarmStart ( AbcSimplex model,
int  type 
)

Constructs a warm start object with the specified status vectors.

The parameters are copied. Consider assignBasisStatus(int,int,char*&,char*&) if the object should assume ownership.

See Also
AbcWarmStart::Status for a description of the packing used in the status arrays.
AbcWarmStart::AbcWarmStart ( const AbcWarmStart ws)

Copy constructor.

virtual AbcWarmStart::~AbcWarmStart ( )
virtual

Destructor.

Member Function Documentation

virtual void AbcWarmStart::setSize ( int  ns,
int  na 
)
virtual

Set basis capacity; existing basis is discarded.

After execution of this routine, the warm start object does not describe a valid basis: all structural and artificial variables have status isFree.

Reimplemented from CoinWarmStartBasis.

virtual void AbcWarmStart::resize ( int  newNumberRows,
int  newNumberColumns 
)
virtual

Set basis capacity; existing basis is maintained.

After execution of this routine, the warm start object describes a valid basis: the status of new structural variables (added columns) is set to nonbasic at lower bound, and the status of new artificial variables (added rows) is set to basic. (The basis can be invalid if new structural variables do not have a finite lower bound.)

Reimplemented from CoinWarmStartBasis.

virtual void AbcWarmStart::compressRows ( int  tgtCnt,
const int *  tgts 
)
virtual

Delete a set of rows from the basis.

Warning
This routine assumes that the set of indices to be deleted is sorted in ascending order and contains no duplicates. Use deleteRows() if this is not the case.
The resulting basis is guaranteed valid only if all deleted constraints are slack (hence the associated logicals are basic).

Removal of a tight constraint with a nonbasic logical implies that some basic variable must be made nonbasic. This correction is left to the client.

Reimplemented from CoinWarmStartBasis.

virtual void AbcWarmStart::deleteRows ( int  rawTgtCnt,
const int *  rawTgts 
)
virtual

Delete a set of rows from the basis.

Warning
The resulting basis is guaranteed valid only if all deleted constraints are slack (hence the associated logicals are basic).

Removal of a tight constraint with a nonbasic logical implies that some basic variable must be made nonbasic. This correction is left to the client.

Reimplemented from CoinWarmStartBasis.

virtual void AbcWarmStart::deleteColumns ( int  number,
const int *  which 
)
virtual

Delete a set of columns from the basis.

Warning
The resulting basis is guaranteed valid only if all deleted variables are nonbasic.

Removal of a basic variable implies that some nonbasic variable must be made basic. This correction is left to the client.

Reimplemented from CoinWarmStartBasis.

void AbcWarmStart::setModel ( AbcSimplex model)
inline

Set model.

Definition at line 140 of file AbcWarmStart.hpp.

AbcSimplex* AbcWarmStart::model ( ) const
inline

Get model.

Definition at line 143 of file AbcWarmStart.hpp.

void AbcWarmStart::createBasis0 ( const AbcSimplex model)

Create Basis type 0.

void AbcWarmStart::createBasis12 ( const AbcSimplex model)

Create Basis type 12.

void AbcWarmStart::createBasis34 ( const AbcSimplex model)

Create Basis type 34.

virtual CoinWarmStart* AbcWarmStart::clone ( ) const
inlinevirtual

`Virtual constructor'

Reimplemented from CoinWarmStartBasis.

Definition at line 177 of file AbcWarmStart.hpp.

virtual AbcWarmStart& AbcWarmStart::operator= ( const AbcWarmStart rhs)
virtual

Assignment.

virtual void AbcWarmStart::assignBasisStatus ( int  ns,
int  na,
char *&  sStat,
char *&  aStat 
)
virtual

Assign the status vectors to be the warm start information.

In this method the AbcWarmStart object assumes ownership of the pointers and upon return the argument pointers will be NULL. If copying is desirable, use the array constructor or the assignment operator .

Note
The pointers passed to this method will be freed using delete[], so they must be created using new[].

Reimplemented from CoinWarmStartBasis.

Member Data Documentation

int AbcWarmStart::typeExtraInformation_
protected

Type of basis (always status arrays)

0 - as CoinWarmStartBasis 1,2 - plus factor order as shorts or ints (top bit set means column) 3,4 - plus compact saved factorization add 8 to say steepest edge weights stored (as floats) may want to change next,previous to tree info so can use a different basis for weights

Definition at line 218 of file AbcWarmStart.hpp.

int AbcWarmStart::lengthExtraInformation_
protected

Length of extra information in bytes.

Definition at line 220 of file AbcWarmStart.hpp.

char* AbcWarmStart::extraInformation_
protected

The extra information.

Definition at line 222 of file AbcWarmStart.hpp.

AbcSimplex* AbcWarmStart::model_
protected

Pointer back to AbcSimplex (can only be applied to that)

Definition at line 224 of file AbcWarmStart.hpp.

AbcWarmStartOrganizer* AbcWarmStart::organizer_
protected

Pointer back to AbcWarmStartOrganizer for organization.

Definition at line 226 of file AbcWarmStart.hpp.

AbcWarmStart* AbcWarmStart::previousBasis_
protected

Pointer to previous basis.

Definition at line 228 of file AbcWarmStart.hpp.

AbcWarmStart* AbcWarmStart::nextBasis_
protected

Pointer to next basis.

Definition at line 230 of file AbcWarmStart.hpp.

int AbcWarmStart::stamp_
protected

Sequence stamp for deletion.

Definition at line 232 of file AbcWarmStart.hpp.

int AbcWarmStart::numberValidRows_
protected

Number of valid rows (rest should have slacks) Check to see if weights are OK for these rows and then just btran new ones for weights.

Definition at line 237 of file AbcWarmStart.hpp.


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