Bcp 1.4.4
Loading...
Searching...
No Matches
List of all members
BCP_warmstart_basis Class Reference

This class describes a warmstart information that consists of basis information for structural and artificial variables. More...

#include <BCP_warmstart_basis.hpp>

+ Inheritance diagram for BCP_warmstart_basis:
+ Collaboration diagram for BCP_warmstart_basis:

Public Member Functions

Constructors and destructor
 BCP_warmstart_basis (BCP_buffer &buf)
 Create the object by unpacking it from a buffer.
 
 BCP_warmstart_basis (const char *vfirst, const char *vlast, const char *cfirst, const char *clast)
 Create an explicitly stored warmstart info by considering the two character arrays ([vfirst,vlast) and [cfirst,clast)) as the status arrays for the variables/cuts.
 
 BCP_warmstart_basis (const BCP_warmstart_basis &ws)
 Copy constructor.
 
 ~BCP_warmstart_basis ()
 
virtual CoinWarmStartconvert_to_CoinWarmStart () const
 Return an CoinwarmStart object that can be fed to the LP engine.
 
virtual BCP_storage_t storage () const
 Return how the warmstarting info is stored.
 
virtual BCP_warmstartclone () const
 Make a replica of the current warmstart information.
 
virtual BCP_warmstartempty_wrt_this () const
 Create a warmstart info describing that no change should be done.
 
virtual int storage_size () const
 Return how much memory it'll take to pack this warmstart info.
 
virtual void update (const BCP_warmstart *const change)
 Update the current data with the one in the argument.
 
virtual BCP_warmstartas_change (const BCP_warmstart *const old_ws, const BCP_vec< int > &del_vars, const BCP_vec< int > &del_cuts, const double petol, const double detol) const
 Return a pointer to a warmstart info describing the currently stored data as a change with respect to that stored in old_ws.
 
void pack (BCP_buffer &buf) const
 Pack the warmstart info into a buffer.
 
- Public Member Functions inherited from BCP_warmstart
virtual ~BCP_warmstart ()
 The destructor is pure virtual.
 

Detailed Description

This class describes a warmstart information that consists of basis information for structural and artificial variables.

"basic / on_upper / on_lower" info is stored on 2 bits for every variable. Only the added methods are documented in details on this page, for the inherited methods see the description of the base class.

Definition at line 24 of file BCP_warmstart_basis.hpp.

Constructor & Destructor Documentation

◆ BCP_warmstart_basis() [1/3]

BCP_warmstart_basis::BCP_warmstart_basis ( BCP_buffer & buf)
inline

Create the object by unpacking it from a buffer.

Definition at line 45 of file BCP_warmstart_basis.hpp.

◆ BCP_warmstart_basis() [2/3]

BCP_warmstart_basis::BCP_warmstart_basis ( const char * vfirst,
const char * vlast,
const char * cfirst,
const char * clast )
inline

Create an explicitly stored warmstart info by considering the two character arrays ([vfirst,vlast) and [cfirst,clast)) as the status arrays for the variables/cuts.

Definition at line 50 of file BCP_warmstart_basis.hpp.

◆ BCP_warmstart_basis() [3/3]

BCP_warmstart_basis::BCP_warmstart_basis ( const BCP_warmstart_basis & ws)
inline

Copy constructor.

Definition at line 54 of file BCP_warmstart_basis.hpp.

◆ ~BCP_warmstart_basis()

BCP_warmstart_basis::~BCP_warmstart_basis ( )
inline

Definition at line 57 of file BCP_warmstart_basis.hpp.

Member Function Documentation

◆ convert_to_CoinWarmStart()

virtual CoinWarmStart * BCP_warmstart_basis::convert_to_CoinWarmStart ( ) const
virtual

Return an CoinwarmStart object that can be fed to the LP engine.

The implementation for this class will return an CoinwarmStartBasis object.

Implements BCP_warmstart.

◆ storage()

virtual BCP_storage_t BCP_warmstart_basis::storage ( ) const
virtual

Return how the warmstarting info is stored.

Implements BCP_warmstart.

◆ clone()

virtual BCP_warmstart * BCP_warmstart_basis::clone ( ) const
inlinevirtual

Make a replica of the current warmstart information.

Implements BCP_warmstart.

Definition at line 69 of file BCP_warmstart_basis.hpp.

◆ empty_wrt_this()

virtual BCP_warmstart * BCP_warmstart_basis::empty_wrt_this ( ) const
inlinevirtual

Create a warmstart info describing that no change should be done.

This is really the task of a constructor, but BCP does not know the type of warmstart the user will use, so it will invoke this method for a warmstart that was created by the user. Tricky, isn't it?

Implements BCP_warmstart.

Definition at line 73 of file BCP_warmstart_basis.hpp.

◆ storage_size()

virtual int BCP_warmstart_basis::storage_size ( ) const
inlinevirtual

Return how much memory it'll take to pack this warmstart info.

It is used when comparing which sort of storage is smaller.

Implements BCP_warmstart.

Definition at line 79 of file BCP_warmstart_basis.hpp.

◆ update()

virtual void BCP_warmstart_basis::update ( const BCP_warmstart *const change)
virtual

Update the current data with the one in the argument.

If the argument is of explicit storage then just replace the current data. If it is relative and the current data is explicit then perform the update. Otherwise throw an exception.

Implements BCP_warmstart.

◆ as_change()

virtual BCP_warmstart * BCP_warmstart_basis::as_change ( const BCP_warmstart *const old_ws,
const BCP_vec< int > & del_vars,
const BCP_vec< int > & del_cuts,
const double petol,
const double detol ) const
virtual

Return a pointer to a warmstart info describing the currently stored data as a change with respect to that stored in old_ws.

However, if the currently stored data is shorter to store than the change, then this method can return a copy of the current data! The current data must be explicitly stored and old_ws must be either explicit or can contain no data. Otherwise an exception must be thrown.

Parameters
old_wsthe old warmstart info
del_varsthe indices of the variables that are deleted from the formulation old_ws was created for
del_cutssame for the cuts
petolprimal zero tolerance
detoldual zero tolerance

Implements BCP_warmstart.

◆ pack()

void BCP_warmstart_basis::pack ( BCP_buffer & buf) const
inline

Pack the warmstart info into a buffer.

Definition at line 94 of file BCP_warmstart_basis.hpp.


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