SoPlex Documentation
Loading...
Searching...
No Matches
SPxPricer< R > Class Template Referenceabstract

Abstract pricer base class. More...

#include <spxpricer.h>

Inheritance diagram for SPxPricer< R >:
SPxAutoPR< R > SPxDantzigPR< R > SPxDevexPR< R > SPxHybridPR< R > SPxParMultPR< R > SPxSteepPR< R > SPxWeightPR< R > SPxSteepExPR< R >

Classes

struct  IdxCompare
 Compare class to sort idx/val pairs, used for hypersparse pricing leaving. More...
 
struct  IdxElement
 

Public Types

enum  ViolationType { NOT_VIOLATED = 0 , VIOLATED = 1 , VIOLATED_AND_CHECKED = 2 }
 

Public Member Functions

Initialization
virtual const chargetName () const
 get name of pricer.
 
virtual void load (SPxSolverBase< R > *p_solver)
 loads LP.
 
virtual void clear ()
 unloads LP.
 
virtual SPxSolverBase< R > * solver () const
 returns loaded SPxSolverBase object.
 
virtual R epsilon () const
 returns violation bound theeps.
 
virtual void setEpsilon (R eps)
 sets violation bound.
 
virtual void setType (typename SPxSolverBase< R >::Type)
 sets pricing type.
 
virtual void setRep (typename SPxSolverBase< R >::Representation)
 sets basis representation.
 
Pivoting
virtual int selectLeave ()=0
 returns selected index to leave basis.
 
virtual void left4 (int, SPxId)
 performs leaving pivot.
 
virtual SPxId selectEnter ()=0
 selects Id to enter basis.
 
virtual void entered4 (SPxId, int)
 performs entering pivot.
 
Extension
virtual void addedVecs (int)
 n vectors have been added to loaded LP.
 
virtual void addedCoVecs (int)
 n covectors have been added to loaded LP.
 
Shrinking
virtual void removedVec (int)
 vector i was removed from loaded LP.
 
virtual void removedVecs (const int *)
 vectors given by perm have been removed from loaded LP.
 
virtual void removedCoVec (int)
 covector i was removed from loaded LP.
 
virtual void removedCoVecs (const int *)
 covectors given by perm have been removed from loaded LP.
 
Debugging
virtual bool isConsistent () const
 
Constructors / Destructors
 SPxPricer (const char *p_name)
 constructor
 
 SPxPricer (const SPxPricer &old)
 copy constructor
 
SPxPriceroperator= (const SPxPricer &rhs)
 assignment operator
 
virtual ~SPxPricer ()
 destructor.
 
virtual SPxPricerclone () const =0
 clone function for polymorphism
 

Protected Attributes

IdxCompare compare
 
Data
const charm_name
 name of the pricer
 
SPxSolverBase< R > * thesolver
 the solver
 
R theeps
 violation bound
 

Detailed Description

template<class R>
class soplex::SPxPricer< R >

Abstract pricer base class.

Class SPxPricer is a pure virtual class defining the interface for pricer classes to be used by SoPlex. The pricer's task is to select a vector to enter or leave the simplex basis, depending on the chosen simplex type.

An SPxPricer first loads the SoPlex object for which pricing is to be performed. Then, depending of the SPxSolverBase<R>::Type, methods selectEnter() and entered4() (for entering Simplex) or selectLeave() and left4() (for leaving Simplex) are called by SoPlex. The SPxPricer object is informed of a change of the SPxSolverBase<R>::Type by calling method setType().

Definition at line 56 of file spxpricer.h.

Member Enumeration Documentation

◆ ViolationType

template<class R >
enum ViolationType
Enumerator
NOT_VIOLATED 
VIOLATED 
VIOLATED_AND_CHECKED 

Definition at line 106 of file spxpricer.h.

Constructor & Destructor Documentation

◆ SPxPricer() [1/2]

template<class R >
SPxPricer ( const char * p_name)
explicit

constructor

Definition at line 276 of file spxpricer.h.

◆ SPxPricer() [2/2]

template<class R >
SPxPricer ( const SPxPricer< R > & old)

copy constructor

Definition at line 283 of file spxpricer.h.

◆ ~SPxPricer()

template<class R >
virtual ~SPxPricer ( )
virtual

destructor.

Definition at line 304 of file spxpricer.h.

References SPxPricer< R >::m_name, and SPxPricer< R >::thesolver.

Member Function Documentation

◆ addedCoVecs()

template<class R >
virtual void addedCoVecs ( int )
virtual

n covectors have been added to loaded LP.

Reimplemented in SPxDevexPR< R >, SPxHybridPR< R >, SPxSteepPR< R >, and SPxWeightPR< R >.

Definition at line 238 of file spxpricer.h.

◆ addedVecs()

template<class R >
virtual void addedVecs ( int )
virtual

n vectors have been added to loaded LP.

Reimplemented in SPxDevexPR< R >, SPxHybridPR< R >, SPxSteepPR< R >, and SPxWeightPR< R >.

Definition at line 235 of file spxpricer.h.

◆ clear()

template<class R >
virtual void clear ( )
virtual

unloads LP.

Reimplemented in SPxAutoPR< R >, SPxHybridPR< R >, and SPxSteepPR< R >.

Definition at line 131 of file spxpricer.h.

References SPxPricer< R >::thesolver.

◆ clone()

template<class R >
virtual SPxPricer * clone ( ) const
pure virtual

◆ entered4()

template<class R >
virtual void entered4 ( SPxId ,
int  )
virtual

performs entering pivot.

Method entered4() is called after each simplex iteration in ENTER mode. It informs the SPxPricer that variable id has entered at the n 'th position. When being called, all vectors of SoPlex involved in such an entering update are setup correctly and may be accessed via the corresponding methods (fVec(), pVec(), etc.). In general, argument id will be the one returned by the SPxPricer at the previous call to selectEnter(). However, one can not rely on this.

Reimplemented in SPxAutoPR< R >, SPxDevexPR< R >, SPxHybridPR< R >, and SPxSteepPR< R >.

Definition at line 226 of file spxpricer.h.

◆ epsilon()

template<class R >
virtual R epsilon ( ) const
virtual

returns violation bound theeps.

Definition at line 143 of file spxpricer.h.

References SPxPricer< R >::theeps.

◆ getName()

template<class R >
virtual const char * getName ( ) const
virtual

get name of pricer.

Definition at line 117 of file spxpricer.h.

References SPxPricer< R >::m_name.

◆ isConsistent()

template<class R >
virtual bool isConsistent ( ) const
virtual

Reimplemented in SPxDevexPR< R >, SPxHybridPR< R >, SPxSteepPR< R >, and SPxWeightPR< R >.

Definition at line 262 of file spxpricer.h.

References SPxPricer< R >::thesolver.

Referenced by SPxPricer< R >::operator=().

◆ left4()

template<class R >
virtual void left4 ( int ,
SPxId  )
virtual

performs leaving pivot.

Method left4() is called after each simplex iteration in LEAVE mode. It informs the SPxPricer that the n 'th variable has left the basis for id to come in at this position. When being called, all vectors of SoPlex involved in such an entering update are setup correctly and may be accessed via the corresponding methods (fVec(), pVec(), etc.). In general, argument n will be the one returned by the SPxPricer at the previous call to selectLeave(). However, one can not rely on this.

Reimplemented in SPxAutoPR< R >, SPxDevexPR< R >, SPxHybridPR< R >, and SPxSteepPR< R >.

Definition at line 198 of file spxpricer.h.

◆ load()

template<class R >
virtual void load ( SPxSolverBase< R > * p_solver)
virtual

loads LP.

Loads the solver and LP for which pricing steps are to be performed.

Reimplemented in SPxAutoPR< R >, SPxDevexPR< R >, SPxSteepPR< R >, SPxWeightPR< R >, SPxHybridPR< R >, and SPxParMultPR< R >.

Definition at line 125 of file spxpricer.h.

References SPxPricer< R >::thesolver.

◆ operator=()

◆ removedCoVec()

template<class R >
virtual void removedCoVec ( int )
virtual

covector i was removed from loaded LP.

Reimplemented in SPxSteepPR< R >, and SPxWeightPR< R >.

Definition at line 252 of file spxpricer.h.

◆ removedCoVecs()

template<class R >
virtual void removedCoVecs ( const int * )
virtual

covectors given by perm have been removed from loaded LP.

Definition at line 255 of file spxpricer.h.

◆ removedVec()

template<class R >
virtual void removedVec ( int )
virtual

vector i was removed from loaded LP.

Reimplemented in SPxSteepPR< R >, and SPxWeightPR< R >.

Definition at line 246 of file spxpricer.h.

◆ removedVecs()

template<class R >
virtual void removedVecs ( const int * )
virtual

vectors given by perm have been removed from loaded LP.

Definition at line 249 of file spxpricer.h.

◆ selectEnter()

template<class R >
virtual SPxId selectEnter ( )
pure virtual

selects Id to enter basis.

Selects the SPxId of a vector to enter the basis. The selected id, must not represent a basic index (i.e. solver()->isBasic(id) must be false). However, the corresponding test value needs not to be less than -epsilon(). If not, SoPlex will discard the pivot.

Note: When method selectEnter() is called by the loaded SoPlex object, all values from coTest() are up to date. However, whether the elements of test() are up to date depends on the SPxSolverBase<R>::Pricing type.

Implemented in SPxAutoPR< R >, SPxDantzigPR< R >, SPxDevexPR< R >, SPxHybridPR< R >, SPxParMultPR< R >, SPxSteepPR< R >, and SPxWeightPR< R >.

◆ selectLeave()

template<class R >
virtual int selectLeave ( )
pure virtual

returns selected index to leave basis.

Selects the index of a vector to leave the basis. The selected index i, say, must be in the range 0 <= i < solver()->dim() and its tested value must fullfill solver()->test()[i] < -epsilon().

Implemented in SPxAutoPR< R >, SPxDantzigPR< R >, SPxDevexPR< R >, SPxHybridPR< R >, SPxParMultPR< R >, SPxSteepPR< R >, and SPxWeightPR< R >.

◆ setEpsilon()

template<class R >
virtual void setEpsilon ( R eps)
virtual

sets violation bound.

Inequality violations are accepted, if their size is less than eps.

Reimplemented in SPxAutoPR< R >, and SPxHybridPR< R >.

Definition at line 151 of file spxpricer.h.

References SPxPricer< R >::theeps.

◆ setRep()

template<class R >
virtual void setRep ( typename SPxSolverBase< R >::Representation )
virtual

sets basis representation.

Informs pricer about (a change of) the loaded SoPlex's Representation.

Reimplemented in SPxHybridPR< R >, SPxSteepPR< R >, SPxWeightPR< R >, SPxAutoPR< R >, and SPxDevexPR< R >.

Definition at line 173 of file spxpricer.h.

◆ setType()

template<class R >
virtual void setType ( typename SPxSolverBase< R >::Type )
virtual

sets pricing type.

Informs pricer about (a change of) the loaded SoPlex's Type. In the sequel, only the corresponding select methods may be called.

Reimplemented in SPxHybridPR< R >, SPxParMultPR< R >, SPxWeightPR< R >, SPxAutoPR< R >, SPxDevexPR< R >, and SPxSteepPR< R >.

Definition at line 162 of file spxpricer.h.

References SPxPricer< R >::thesolver.

◆ solver()

template<class R >
virtual SPxSolverBase< R > * solver ( ) const
virtual

returns loaded SPxSolverBase object.

Definition at line 137 of file spxpricer.h.

References SPxPricer< R >::thesolver.

Member Data Documentation

◆ compare

template<class R >
IdxCompare compare
protected

Definition at line 101 of file spxpricer.h.

◆ m_name

template<class R >
const char* m_name
protected

name of the pricer

Definition at line 64 of file spxpricer.h.

Referenced by SPxPricer< R >::getName(), SPxPricer< R >::operator=(), and SPxPricer< R >::~SPxPricer().

◆ theeps

template<class R >
R theeps
protected

violation bound

Definition at line 70 of file spxpricer.h.

Referenced by SPxPricer< R >::epsilon(), SPxPricer< R >::operator=(), and SPxPricer< R >::setEpsilon().

◆ thesolver