solver
solver::OptimizationVariable Class Reference

Class that contains all information about the optimization variables such as upper and lower bounds, initial guess if any, and some auxiliary functions for easier handling. More...

#include <OptVar.hpp>

Public Types

typedef Eigen::Matrix< double, Eigen::Dynamic, 1, Eigen::ColMajor, Eigen::Dynamic, 1 > OptVector
 
typedef Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor, Eigen::Dynamic, Eigen::Dynamic > OptMatrix
 

Public Member Functions

 OptimizationVariable ()
 Class constructor and destructor.
 
void initialize (const char &type, int rows, int cols, double lBnd, double uBnd, int &startIndexInOptVec)
 Some alternative initialization functions.
 
void initialize (const char &type, int rows, int cols, OptVector &lBnd, OptVector &uBnd, int &startIndexInOptVec)
 
void initialize (const char &type, int rows, int cols, OptMatrix &lBnd, OptMatrix &uBnd, int &startIndexInOptVec)
 
void initialize (const char &type, int rows, int cols, double lBnd, double uBnd, int &startIndexInOptVec, double guess)
 
void initialize (const char &type, int rows, int cols, double lBnd, double uBnd, int &startIndexInOptVec, OptMatrix &guess)
 
void initialize (const char &type, int rows, int cols, OptVector &lBnd, OptVector &uBnd, int &startIndexInOptVec, OptMatrix &guess)
 
void initialize (const char &type, int rows, int cols, OptMatrix &lBnd, OptMatrix &uBnd, int &startIndexInOptVec, OptMatrix &guess)
 
int id (int row, int col) const
 Some helper functions to construct the problem.
 
void constraintIndexToCurrentValue (int index)
 
void setAndConstraintIndexToCurrentValue (int index, double value)
 
void setAndConstraintIndexToCurrentValue (int index, OptVector &value)
 
void getValues (OptMatrix &lBnd, OptMatrix &uBnd, OptMatrix &guess, int &size, char &type) const
 
int getNumRows () const
 Some getter and setter methods.
 
int getNumCols () const
 
int getStartIndex () const
 
int getNumElements () const
 
void getGuessValue (OptMatrix &guess) const
 
void getGuessValueByCol (int index, OptVector &guess) const
 
void setGuessValue (const OptMatrix &guess)
 

Private Member Functions

int getRowBndInd (int row) const
 Some helper functions to construct the problem.
 
int getColBndInd (int col) const
 
int getBlockLen (int rini, int cini, int rend, int cend) const
 

Private Attributes

char type_
 
bool guessValueInitialized_
 
int indexPosition_
 
int rows_
 
int cols_
 
OptMatrix lBndMat_
 
OptMatrix uBndMat_
 
OptMatrix guessMat_
 

Detailed Description

Class that contains all information about the optimization variables such as upper and lower bounds, initial guess if any, and some auxiliary functions for easier handling.


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