Interior-point-optimisation  1.0-1
Interior-pointoptimisationlibrary
ipo::Model::Subvector Class Referenceabstract

Abstract base class for subvector classes. More...

Inheritance diagram for ipo::Model::Subvector:
Inheritance graph
Collaboration diagram for ipo::Model::Subvector:
Collaboration graph

Public Member Functions

 Subvector ()
 Default constructor. More...
 
virtual gsl::vector const get (gsl::vector const &vector) const =0
 Get a subvector of vector. More...
 
virtual void set (gsl::vector &vector, gsl::vector const &subvector, double const scale=1.0) const =0
 Set vector from a subvector. More...
 
virtual void add (gsl::vector &vector, gsl::vector const &subvector, double const scale=1.0) const =0
 Add to vector from a subvector. More...
 
virtual void set (gsl::matrix &matrix, gsl::matrix const &submatrix, double const scale=1.0) const =0
 Set matrix from a submatrix. More...
 
virtual void add (gsl::matrix &matrix, gsl::matrix const &submatrix, double const scale=1.0) const =0
 Add to matrix from a submatrix Computes matrix += scale * [expanded] submatrix. More...
 
virtual void set (gsl::matrix &matrix, gsl::vector const &vector, double const scale=1.0) const =0
 Set matrix from a vector. More...
 
virtual void add (gsl::matrix &matrix, gsl::vector const &vector, double const scale=1.0) const =0
 Add to matrix from a vector Computes matrix += scale * [expanded] submatrix * [expanded] vector transpose. More...
 

Detailed Description

Abstract base class for subvector classes.

These are used internally to allow the the interior point algorithm to run faster if all the constraints use either precisely one of the objective variables or all of them in the same order.

Definition at line 408 of file Model.hpp.

Constructor & Destructor Documentation

ipo::Model::Subvector::Subvector ( )
inline

Default constructor.

Definition at line 413 of file Model.hpp.

Member Function Documentation

virtual void ipo::Model::Subvector::add ( gsl::vector &  vector,
gsl::vector const &  subvector,
double const  scale = 1.0 
) const
pure virtual

Add to vector from a subvector.

Parameters
vectorThe vector
subvectorThe subvector
scaleA scaling factor: computes vector += scale * [expanded] subvector

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.

virtual void ipo::Model::Subvector::add ( gsl::matrix &  matrix,
gsl::matrix const &  submatrix,
double const  scale = 1.0 
) const
pure virtual

Add to matrix from a submatrix Computes matrix += scale * [expanded] submatrix.

Parameters
matrixThe matrix
submatrixThe submatrix
scaleA scaling factor

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.

virtual void ipo::Model::Subvector::add ( gsl::matrix &  matrix,
gsl::vector const &  vector,
double const  scale = 1.0 
) const
pure virtual

Add to matrix from a vector Computes matrix += scale * [expanded] submatrix * [expanded] vector transpose.

Parameters
matrixThe matrix
vectorThe vector
scaleA scaling factor

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.

virtual gsl::vector const ipo::Model::Subvector::get ( gsl::vector const &  vector) const
pure virtual

Get a subvector of vector.

Parameters
vectorThe vector
Returns
a subvector of vector

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.

virtual void ipo::Model::Subvector::set ( gsl::vector &  vector,
gsl::vector const &  subvector,
double const  scale = 1.0 
) const
pure virtual

Set vector from a subvector.

Parameters
vectorThe vector
subvectorThe subvector
scaleA scaling factor: computes vector += scale * [expanded] subvector

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.

virtual void ipo::Model::Subvector::set ( gsl::matrix &  matrix,
gsl::matrix const &  submatrix,
double const  scale = 1.0 
) const
pure virtual

Set matrix from a submatrix.

Parameters
matrixThe matrix
submatrixThe submatrix
scaleA scaling factor: computes matrix += scale * [expanded] submatrix

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.

virtual void ipo::Model::Subvector::set ( gsl::matrix &  matrix,
gsl::vector const &  vector,
double const  scale = 1.0 
) const
pure virtual

Set matrix from a vector.

Parameters
matrixThe matrix
vectorThe vector
scaleA scaling factor: computes matrix += scale * [expanded] vector * [expanded] vector transpose

Implemented in ipo::Model::IndirectSubvector, and ipo::Model::DirectSubvector.


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