SoPlex Documentation
Loading...
Searching...
No Matches
SLUFactorRational Class Reference

Implementation of Sparse Linear Solver with Rational precision. More...

#include <slufactor_rational.h>

Inheritance diagram for SLUFactorRational:
SLinSolverRational CLUFactorRational

Public Types

Types
enum  UpdateType { ETA = 0 , FOREST_TOMLIN }
 Specifies how to perform change method. More...
 
typedef SLinSolverRational::Status Status
 for convenience
 
- Public Types inherited from SLinSolverRational
enum  Status {
  OK = 0 , INSTABLE = 1 , SINGULAR = 2 , UNLOADED = 4 ,
  ERROR = 8 , TIME = 16
}
 status flags of the SLinSolverRational class. More...
 

Public Member Functions

Update type
UpdateType utype () const
 returns the current update type uptype.
 
void setUtype (UpdateType tp)
 sets update type.
 
void setMarkowitz (const Rational &m)
 sets minimum Markowitz threshold.
 
Rational markowitz ()
 returns Markowitz threshold.
 
Derived from SLinSolverRational

See documentation of SLinSolverRational for a documentation of these methods.

void clear ()
 
int dim () const
 
int memory () const
 
const char * getName () const
 
Status status () const
 
Rational stability () const
 
std::string statistics () const
 
Status load (const SVectorRational *vec[], int dim)
 
Solve
void solveRight (VectorRational &x, const VectorRational &b)
 Solves \(Ax=b\).
 
void solveRight (SSVectorRational &x, const SVectorRational &b)
 Solves \(Ax=b\).
 
void solveRight4update (SSVectorRational &x, const SVectorRational &b)
 Solves \(Ax=b\).
 
void solve2right4update (SSVectorRational &x, VectorRational &y, const SVectorRational &b, SSVectorRational &d)
 Solves \(Ax=b\) and \(Ay=d\).
 
void solve3right4update (SSVectorRational &x, VectorRational &y, VectorRational &z, const SVectorRational &b, SSVectorRational &d, SSVectorRational &e)
 Solves \(Ax=b\), \(Ay=d\) and \(Az=e\).
 
void solveLeft (VectorRational &x, const VectorRational &b)
 Solves \(Ax=b\).
 
void solveLeft (SSVectorRational &x, const SVectorRational &b)
 Solves \(Ax=b\).
 
void solveLeft (SSVectorRational &x, VectorRational &y, const SVectorRational &b, SSVectorRational &d)
 Solves \(Ax=b\) and \(Ay=d\).
 
void solveLeft (SSVectorRational &x, VectorRational &y, VectorRational &z, const SVectorRational &b, SSVectorRational &d, SSVectorRational &e)
 Solves \(Ax=b\), \(Ay=d\) and \(Az=e\).
 
Status change (int idx, const SVectorRational &subst, const SSVectorRational *eta=nullptr)
 
Miscellaneous
Real getFactorTime () const
 time spent in factorizations
 
void setTimeLimit (const Real limit)
 set time limit on factorization
 
void resetFactorTime ()
 reset FactorTime
 
int getFactorCount () const
 number of factorizations performed
 
Real getSolveTime () const
 time spent in solves
 
void resetSolveTime ()
 reset SolveTime
 
int getSolveCount () const
 number of solves performed
 
void resetCounters ()
 reset timers and counters
 
void dump () const
 prints the LU factorization to stdout.
 
bool isConsistent () const
 consistency check.
 
Constructors / Destructors
 SLUFactorRational ()
 default constructor.
 
SLUFactorRationaloperator= (const SLUFactorRational &old)
 assignment operator.
 
 SLUFactorRational (const SLUFactorRational &old)
 copy constructor.
 
virtual ~SLUFactorRational ()
 destructor.
 
virtual SLinSolverRationalclone () const
 clone function for polymorphism
 
- Public Member Functions inherited from SLinSolverRational
 SLinSolverRational ()
 default constructor
 
virtual ~SLinSolverRational ()
 destructor
 

Protected Member Functions

Protected helpers
void freeAll ()
 
void changeEta (int idx, SSVectorRational &eta)
 
void init ()
 
- Protected Member Functions inherited from CLUFactorRational
void solveLright (Rational *vec)
 
int solveRight4update (Rational *vec, int *nonz, Rational *rhs, Rational *forest, int *forestNum, int *forestIdx)
 
void solveRight (Rational *vec, Rational *rhs)
 
int solveRight2update (Rational *vec1, Rational *vec2, Rational *rhs1, Rational *rhs2, int *nonz, Rational *forest, int *forestNum, int *forestIdx)
 
void solveRight2 (Rational *vec1, Rational *vec2, Rational *rhs1, Rational *rhs2)
 
void solveLeft (Rational *vec, Rational *rhs)
 
int solveLeftEps (Rational *vec, Rational *rhs, int *nonz)
 
int solveLeft2 (Rational *vec1, int *nonz, Rational *vec2, Rational *rhs1, Rational *rhs2)
 
int vSolveRight4update (Rational *vec, int *idx, Rational *rhs, int *ridx, int rn, Rational *forest, int *forestNum, int *forestIdx)
 
int vSolveRight4update2 (Rational *vec, int *idx, Rational *rhs, int *ridx, int rn, Rational *vec2, Rational *rhs2, int *ridx2, int rn2, Rational *forest, int *forestNum, int *forestIdx)
 
int vSolveRight4update3 (Rational *vec, int *idx, Rational *rhs, int *ridx, int rn, Rational *vec2, Rational *rhs2, int *ridx2, int rn2, Rational *vec3, Rational *rhs3, int *ridx3, int rn3, Rational *forest, int *forestNum, int *forestIdx)
 
void vSolveRightNoNZ (Rational *vec2, Rational *rhs2, int *ridx2, int rn2)
 
int vSolveLeft (Rational *vec, int *idx, Rational *rhs, int *ridx, int rn)
 
void vSolveLeftNoNZ (Rational *vec, Rational *rhs, int *ridx, int rn)
 
int vSolveLeft2 (Rational *vec, int *idx, Rational *rhs, int *ridx, int rn, Rational *vec2, Rational *rhs2, int *ridx2, int rn2)
 
int vSolveLeft3 (Rational *vec, int *idx, Rational *rhs, int *ridx, int rn, Rational *vec2, Rational *rhs2, int *ridx2, int rn2, Rational *vec3, Rational *rhs3, int *ridx3, int rn3)
 
void forestUpdate (int col, Rational *work, int num, int *nonz)
 
void update (int p_col, Rational *p_work, const int *p_idx, int num)
 
void updateNoClear (int p_col, const Rational *p_work, const int *p_idx, int num)
 
void factor (const SVectorRational **vec, const Rational &threshold)
 
void dump () const
 
bool isConsistent () const
 

Protected Attributes

Protected data
bool usetup
 TRUE iff update vector has been setup.
 
UpdateType uptype
 the current UpdateType.
 
SSVectorRational eta
 
SSVectorRational forest
 ? Update vector set up by solveRight4update() and solve2right4update()
 
Rational lastThreshold
 pivoting threshold of last factorization
 
Control Parameters
Rational minThreshold
 minimum threshold to use.
 
Rational minStability
 minimum stability to achieve by setting threshold.
 
TimersolveTime
 Time spent in solves.
 
Timer::TYPE timerType
 
int solveCount
 Number of solves.
 
- Protected Attributes inherited from CLUFactorRational
SLinSolverRational::Status stat
 Status indicator.
 
int thedim
 dimension of factorized matrix
 
int nzCnt
 number of nonzeros in U
 
Rational initMaxabs
 maximum abs number in initail Matrix
 
Rational maxabs
 maximum abs number in L and U
 
Real rowMemMult
 factor of minimum Memory * number of nonzeros
 
Real colMemMult
 factor of minimum Memory * number of nonzeros
 
Real lMemMult
 factor of minimum Memory * number of nonzeros
 
Perm row
 row permutation matrices
 
Perm col
 column permutation matrices
 
L l
 L matrix.
 
VectorRational diag
 Array of pivot elements.
 
U u
 U matrix.
 
Rationalwork
 Working array: must always be left as 0!
 
TimerfactorTime
 Time spent in factorizations.
 
int factorCount
 Number of factorizations.
 
Real timeLimit
 Time limit on factorization or solves.
 

Private Member Functions

Private helpers
void assign (const SLUFactorRational &old)
 used to implement the assignment operator
 

Private Attributes

Private data
VectorRational vec
 Temporary vector.
 
SSVectorRational ssvec
 Temporary semi-sparse vector.
 

Detailed Description

Implementation of Sparse Linear Solver with Rational precision.

This class implements a SLinSolverRational interface by using the sparse LU factorization implemented in CLUFactorRational.

Definition at line 50 of file slufactor_rational.h.

Member Typedef Documentation

◆ Status

for convenience

Definition at line 64 of file slufactor_rational.h.

Member Enumeration Documentation

◆ UpdateType

enum UpdateType

Specifies how to perform change method.

Enumerator
ETA 
FOREST_TOMLIN 

Definition at line 58 of file slufactor_rational.h.

Constructor & Destructor Documentation

◆ SLUFactorRational() [1/2]

default constructor.

Definition at line 288 of file slufactor_rational.h.

References CLUFactorRational::col, CLUFactorRational::U::col, TimerFactory::createTimer(), CLUFactorRational::diag, VectorBase< R >::dim(), CLUFactorRational::U::Col::elem, CLUFactorRational::U::Row::elem, CLUFactorRational::factorCount, CLUFactorRational::factorTime, CLUFactorRational::L::firstUnused, CLUFactorRational::L::firstUpdate, SLUFactorRational::freeAll(), VectorBase< R >::get_ptr(), CLUFactorRational::Dring::idx, CLUFactorRational::L::idx, CLUFactorRational::U::Col::idx, CLUFactorRational::U::Row::idx, SLUFactorRational::init(), SLUFactorRational::isConsistent(), CLUFactorRational::l, CLUFactorRational::U::Col::len, CLUFactorRational::U::Row::len, CLUFactorRational::U::Col::list, CLUFactorRational::U::Row::list, CLUFactorRational::U::Col::max, CLUFactorRational::U::Row::max, CLUFactorRational::nzCnt, CLUFactorRational::Perm::orig, CLUFactorRational::Perm::perm, CLUFactorRational::L::rbeg, VectorBase< R >::reDim(), CLUFactorRational::L::ridx, CLUFactorRational::L::rorig, CLUFactorRational::L::row, CLUFactorRational::row, CLUFactorRational::U::row, CLUFactorRational::L::rperm, CLUFactorRational::L::rval, CLUFactorRational::U::Col::size, SLUFactorRational::solveCount, SLUFactorRational::solveTime, soplex::spx_alloc(), CLUFactorRational::L::start, CLUFactorRational::U::Col::start, CLUFactorRational::U::Row::start, CLUFactorRational::L::startSize, CLUFactorRational::thedim, CLUFactorRational::timeLimit, SLUFactorRational::timerType, CLUFactorRational::u, CLUFactorRational::U::Col::used, CLUFactorRational::U::Row::used, CLUFactorRational::L::val, CLUFactorRational::U::Col::val, CLUFactorRational::U::Row::val, SLUFactorRational::vec, and CLUFactorRational::work.

Referenced by SLUFactorRational::clone().

◆ SLUFactorRational() [2/2]

◆ ~SLUFactorRational()

virtual ~SLUFactorRational ( )
virtual

destructor.

Member Function Documentation

◆ assign()

void assign ( const SLUFactorRational & old)
private

used to implement the assignment operator

Referenced by SLUFactorRational::operator=(), and SLUFactorRational::SLUFactorRational().

◆ change()

Status change ( int idx,
const SVectorRational & subst,
const SSVectorRational * eta = nullptr )
virtual

Implements SLinSolverRational.

◆ changeEta()

void changeEta ( int idx,
SSVectorRational & eta )
protected

◆ clear()

void clear ( )
virtual

Implements SLinSolverRational.

◆ clone()

virtual SLinSolverRational * clone ( ) const
virtual

clone function for polymorphism

Implements SLinSolverRational.

Definition at line 498 of file slufactor_rational.h.

References SLUFactorRational::SLUFactorRational().

◆ dim()

int dim ( ) const
virtual

Implements SLinSolverRational.

Definition at line 173 of file slufactor_rational.h.

References CLUFactorRational::thedim.

◆ dump()

void dump ( ) const

prints the LU factorization to stdout.

◆ freeAll()

◆ getFactorCount()

int getFactorCount ( ) const
virtual

number of factorizations performed

Implements SLinSolverRational.

Definition at line 250 of file slufactor_rational.h.

References CLUFactorRational::factorCount.

◆ getFactorTime()

Real getFactorTime ( ) const

time spent in factorizations

Definition at line 235 of file slufactor_rational.h.

References CLUFactorRational::factorTime, and Timer::time().

◆ getName()

const char * getName ( ) const
virtual

Implements SLinSolverRational.

Definition at line 183 of file slufactor_rational.h.

References SLUFactorRational::ETA, and SLUFactorRational::uptype.

◆ getSolveCount()

int getSolveCount ( ) const

number of solves performed

Definition at line 265 of file slufactor_rational.h.

References SLUFactorRational::solveCount.

◆ getSolveTime()

Real getSolveTime ( ) const

time spent in solves

Definition at line 255 of file slufactor_rational.h.

References SLUFactorRational::solveTime, and Timer::time().

◆ init()

void init ( )
protected

◆ isConsistent()

bool isConsistent ( ) const
virtual

◆ load()

Status load ( const SVectorRational * vec[],
int dim )
virtual

Implements SLinSolverRational.

◆ markowitz()

Rational markowitz ( )

returns Markowitz threshold.

Definition at line 158 of file slufactor_rational.h.

References SLUFactorRational::lastThreshold.

◆ memory()

◆ operator=()

◆ resetCounters()

void resetCounters ( )

◆ resetFactorTime()

void resetFactorTime ( )

reset FactorTime

Definition at line 245 of file slufactor_rational.h.

References CLUFactorRational::factorTime, and Timer::reset().

◆ resetSolveTime()

void resetSolveTime ( )

reset SolveTime

Definition at line 260 of file slufactor_rational.h.

References Timer::reset(), and SLUFactorRational::solveTime.

◆ setMarkowitz()

void setMarkowitz ( const Rational & m)

sets minimum Markowitz threshold.

Definition at line 138 of file slufactor_rational.h.

References SLUFactorRational::lastThreshold, and SLUFactorRational::minThreshold.

◆ setTimeLimit()

void setTimeLimit ( const Real limit)

set time limit on factorization

Definition at line 240 of file slufactor_rational.h.

References CLUFactorRational::timeLimit.

◆ setUtype()

void setUtype ( UpdateType tp)

sets update type.

The new UpdateType becomes valid only after the next call to method load().

Definition at line 132 of file slufactor_rational.h.

References SLUFactorRational::uptype.

◆ solve2right4update()

void solve2right4update ( SSVectorRational & x,
VectorRational & y,
const SVectorRational & b,
SSVectorRational & d )
virtual

Solves \(Ax=b\) and \(Ay=d\).

Implements SLinSolverRational.

◆ solve3right4update()

void solve3right4update ( SSVectorRational & x,
VectorRational & y,
VectorRational & z,
const SVectorRational & b,
SSVectorRational & d,
SSVectorRational & e )
virtual

Solves \(Ax=b\), \(Ay=d\) and \(Az=e\).

Implements SLinSolverRational.

◆ solveLeft() [1/4]

void solveLeft ( SSVectorRational & x,
const SVectorRational & b )
virtual

Solves \(Ax=b\).

Implements SLinSolverRational.

◆ solveLeft() [2/4]

void solveLeft ( SSVectorRational & x,
VectorRational & y,
const SVectorRational & b,
SSVectorRational & d )
virtual

Solves \(Ax=b\) and \(Ay=d\).

Implements SLinSolverRational.

◆ solveLeft() [3/4]

void solveLeft ( SSVectorRational & x,
VectorRational & y,
VectorRational & z,
const SVectorRational & b,
SSVectorRational & d,
SSVectorRational & e )
virtual

Solves \(Ax=b\), \(Ay=d\) and \(Az=e\).

Implements SLinSolverRational.

◆ solveLeft() [4/4]

void solveLeft ( VectorRational & x,
const VectorRational & b )
virtual

Solves \(Ax=b\).

Implements SLinSolverRational.

◆ solveRight() [1/2]

void solveRight ( SSVectorRational & x,
const SVectorRational & b )
virtual

Solves \(Ax=b\).

Implements SLinSolverRational.

◆ solveRight() [2/2]

void solveRight ( VectorRational & x,
const VectorRational & b )
virtual

Solves \(Ax=b\).

Implements SLinSolverRational.

◆ solveRight4update()

void solveRight4update ( SSVectorRational & x,
const SVectorRational & b )
virtual

Solves \(Ax=b\).

Implements SLinSolverRational.

◆ stability()

Rational stability ( ) const
virtual

Implements SLinSolverRational.

◆ statistics()

std::string statistics ( ) const
virtual

Implements SLinSolverRational.

◆ status()

Status status ( ) const
virtual

Implements SLinSolverRational.

Definition at line 188 of file slufactor_rational.h.

References CLUFactorRational::stat.

◆ utype()

UpdateType utype ( ) const

returns the current update type uptype.

Definition at line 123 of file slufactor_rational.h.

References SLUFactorRational::uptype.

Member Data Documentation

◆ eta

SSVectorRational eta
protected

Definition at line 83 of file slufactor_rational.h.

Referenced by SLUFactorRational::operator=().

◆ forest

SSVectorRational forest
protected

? Update vector set up by solveRight4update() and solve2right4update()

Definition at line 85 of file slufactor_rational.h.

Referenced by SLUFactorRational::operator=().

◆ lastThreshold

Rational lastThreshold
protected

pivoting threshold of last factorization

Definition at line 86 of file slufactor_rational.h.

Referenced by SLUFactorRational::markowitz(), and SLUFactorRational::setMarkowitz().

◆ minStability

Rational minStability
protected

minimum stability to achieve by setting threshold.

Definition at line 95 of file slufactor_rational.h.

◆ minThreshold

Rational minThreshold
protected

minimum threshold to use.

Definition at line 93 of file slufactor_rational.h.

Referenced by SLUFactorRational::setMarkowitz().

◆ solveCount

◆ solveTime

◆ ssvec

SSVectorRational ssvec
private

Temporary semi-sparse vector.

Definition at line 73 of file slufactor_rational.h.

Referenced by SLUFactorRational::operator=().

◆ timerType

Timer::TYPE timerType
protected

◆ uptype

UpdateType uptype
protected

◆ usetup

bool usetup
protected

TRUE iff update vector has been setup.

Definition at line 81 of file slufactor_rational.h.

◆ vec

VectorRational vec
private

Temporary vector.

Definition at line 72 of file slufactor_rational.h.

Referenced by SLUFactorRational::operator=(), and SLUFactorRational::SLUFactorRational().