515 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
592 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
649 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
707 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
773 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
846 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
937 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1029 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1109 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1167 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1228 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1310 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1386 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1452 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1517 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1564 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
1918 bool setRandom(
double density,
bool conformant,
int iMin,
int iMax);
2310 std::string m_sInstanceName;
2314 std::string m_sInstanceSource;
2318 std::string m_sInstanceDescription;
2322 std::string m_sInstanceCreator;
2326 std::string m_sInstanceLicence;
2333 bool m_bProcessVariables;
2338 int m_iVariableNumber;
2343 int m_iNumberOfIntegerVariables;
2348 int m_iNumberOfBinaryVariables;
2353 int m_iNumberOfSemiContinuousVariables;
2358 int m_iNumberOfSemiIntegerVariables;
2363 int m_iNumberOfStringVariables;
2368 std::string* m_msVariableNames;
2374 char* m_mcVariableTypes;
2379 double* m_mdVariableLowerBounds;
2384 double* m_mdVariableUpperBounds;
2391 bool m_bProcessObjectives;
2396 int m_iObjectiveNumber;
2401 int m_iObjectiveNumberNonlinear;
2406 std::string* m_msObjectiveNames;
2411 std::string* m_msMaxOrMins;
2416 int* m_miNumberOfObjCoef;
2421 double* m_mdObjectiveConstants;
2426 double* m_mdObjectiveWeights;
2437 bool m_bGetDenseObjectives;
2443 double** m_mmdDenseObjectiveCoefficients;
2450 bool m_bProcessConstraints;
2455 int m_iConstraintNumber;
2460 int m_iConstraintNumberNonlinear;
2465 std::string* m_msConstraintNames;
2470 double* m_mdConstraintLowerBounds;
2475 double* m_mdConstraintUpperBounds;
2481 double* m_mdConstraintConstants;
2487 char* m_mcConstraintTypes;
2495 bool m_bProcessLinearConstraintCoefficients;
2501 int m_iLinearConstraintCoefficientNumber;
2507 bool m_bColumnMajor;
2514 SparseMatrix* m_linearConstraintCoefficientsInColumnMajor;
2521 SparseMatrix* m_linearConstraintCoefficientsInRowMajor;
2528 int m_iNumberOfQuadraticRowIndexes;
2533 bool m_bQuadraticRowIndexesProcessed;
2538 int *m_miQuadRowIndexes;
2543 bool m_bProcessQuadraticTerms;
2549 int m_iQuadraticTermNumber;
2559 bool m_bQTermsAdded;
2567 int m_iNumberOfNonlinearExpressionTreeIndexes;
2573 bool m_bNonlinearExpressionTreeIndexesProcessed;
2580 int *m_miNonlinearExpressionTreeIndexes;
2587 int m_iNumberOfNonlinearExpressionTreeModIndexes;
2593 bool m_bNonlinearExpressionTreeModIndexesProcessed;
2599 int *m_miNonlinearExpressionTreeModIndexes;
2606 bool m_binitForAlgDiff;
2612 unsigned int m_iNumberOfNonlinearVariables;
2617 bool m_bProcessNonlinearExpressions;
2622 int m_iNonlinearExpressionNumber;
2628 int* m_miNonlinearExpressionIndexes;
2633 bool m_bProcessExpressionTrees;
2638 bool m_bProcessExpressionTreesMod;
2644 double *m_mdConstraintFunctionValues;
2650 double *m_mdObjectiveFunctionValues;
2655 int m_iJacValueSize;
2670 double *m_mdJacValue;
2676 int *m_miJacNumConTerms;
2687 int m_iHighestTaylorCoeffOrder;
2697 std::map<int, ScalarExpressionTree*> m_mapExpressionTrees;
2703 std::map<int, int> m_mapOSADFunRangeIndex;
2713 std::map<int, MatrixExpressionTree*> m_mapMatrixExpressionTrees;
2724 bool m_bLagrangianExpTreeCreated;
2735 bool m_bLagrangianSparseHessianCreated;
2740 std::map<int, int> m_mapAllNonlinearVariablesIndex;
2746 int *m_miNonLinearVarsReverseMap;
2752 bool m_bAllNonlinearVariablesIndex;
2761 std::map<int, ScalarExpressionTree*> m_mapExpressionTreesMod ;
2768 bool m_bOSADFunIsCreated;
2774 bool m_bCppADTapesBuilt;
2780 bool m_bCppADMustReTape;
2785 bool m_bDuplicateExpressionTreesMap;
2790 bool m_bNonLinearStructuresInitialized;
2795 bool m_bSparseJacobianCalculated;
2802 std::map<int, std::vector<OSnLNode*> > m_mapExpressionTreesInPostfix ;
2808 int m_iHighestOrderEvaluated;
2814 double **m_mmdObjGradient;
2821 std::vector<double> m_vdX;
2826 std::vector<double> m_vdYval;
2832 std::vector<bool> m_vbLagHessNonz;
2837 std::vector<double> m_vdYjacval;
2842 std::vector<double> m_vdw;
2847 std::vector<double> m_vdLambda;
2852 std::vector<double> m_vdDomainUnitVec;
2857 std::vector<double> m_vdRangeUnitVec;
2864 bool m_bProcessMatrices;
2869 int m_iMatrixNumber;
2886 int* m_miMatrixNumberOfColumns;
2891 int* m_miMatrixNumberOfRows;
2896 std::string* m_msMatrixNames;
2956 int m_iMatrixVarNumber;
2961 int m_iMatrixObjNumber;
2966 int m_iMatrixConNumber;
2971 int m_iMatrixExpressionNumber;
2978 bool m_bProcessTimeDomain;
2983 bool m_bProcessTimeStages;
2988 bool m_bProcessTimeInterval;
2993 bool m_bFiniteTimeStages;
2998 int m_iNumberOfTimeStages;
3003 std::string m_sTimeDomainFormat;
3008 std::string* m_msTimeDomainStageNames;
3016 int* m_miTimeDomainStageVariableNumber;
3021 int** m_mmiTimeDomainStageVarList;
3026 int* m_miTimeDomainStageConstraintNumber;
3031 int** m_mmiTimeDomainStageConList;
3036 int* m_miTimeDomainStageObjectiveNumber;
3041 int** m_mmiTimeDomainStageObjList;
3050 bool processVariables();
3058 bool processObjectives();
3066 bool processConstraints();
3074 bool processLinearConstraintCoefficients();
3082 bool processMatrices();
3947 bool addVariable(
int index, std::string name,
double lowerBound,
double upperBound,
char type);
3969 double* upperBounds,
char* types);
3997 bool addObjective(
int index, std::string name, std::string maxOrMin,
double constant,
double weight,
SparseVector* objectiveCoefficients);
4014 bool setObjectives(
int number, std::string *names, std::string *maxOrMins,
double *constants,
double *weights,
SparseVector **objectitiveCoefficients);
4037 bool addConstraint(
int index, std::string name,
double lowerBound,
double upperBound,
double constant);
4052 bool setConstraints(
int number, std::string* names,
double* lowerBounds,
double* upperBounds,
double* constants);
4073 double* values,
int valuesBegin,
int valuesEnd,
4074 int* indexes,
int indexesBegin,
int indexesEnd,
4075 int* starts,
int startsBegin,
int startsEnd);
4096 double* values,
int valuesBegin,
int valuesEnd,
4097 int* indexes,
int indexesBegin,
int indexesEnd,
4098 int* starts,
int startsBegin,
int startsEnd);
4127 int* rowIndexes,
int* varOneIndexes,
int* varTwoIndexes,
4128 double* coefficients,
int begin,
int end);
4145 int* rowIndexes,
int* varOneIndexes,
int* varTwoIndexes,
double* coefficients);
4188 bool addMatrix(
int index, std::string name,
int numberOfRows,
int numberOfColumns,
4190 unsigned int inumberOfChildren,
MatrixNode **m_mChildren);
4228 std::string name,
int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4257 std::string name,
int numberOfComponents,
int* components,
4258 int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4287 std::string name,
int referenceIdx,
int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4315 std::string name, std::string semidefiniteness,
int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4344 std::string name,
int distortionMatrixIdx,
double normFactor,
int axisDirection,
4345 int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4375 std::string name,
int distortionMatrixIdx,
double normFactor,
int firstAxisDirection,
4376 int secondAxisDirection,
int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4405 std::string name,
int distortionMatrixIdx,
double normFactor,
int axisDirection,
double pNorm,
4406 int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4439 std::string name,
int maxDegree,
int numberOfUB,
double* ub,
int numberOfLB,
double* lb,
4440 int numberOfOtherIndexes = 0,
int* otherIndexes = NULL);
4502 bool new_x,
int highestOrder);
4535 bool new_x,
int highestOrder);
4568 double *conLambda,
bool new_x,
int highestOrder);
4587 int idx,
bool new_x,
int highestOrder);
4619 bool new_x,
int highestOrder);
4637 int objIdx,
bool new_x,
int highestOrder);
4672 bool new_x,
int highestOrder);
4752 CppAD::ADFun<double> *Fad;
4777 std::vector<double>
forwardAD(
int p, std::vector<double> vdX);
4789 std::vector<double>
reverseAD(
int p, std::vector<double> vdlambda);
4825 bool new_x,
int highestOrder);
ENUM_MATRIX_TYPE
An enum to track the many different types of values that a matrix can contain Note that these types a...
This file defines the OSnLNode class along with its derived classes.
The CompletelyPositiveMatricesCone Class.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
~CompletelyPositiveMatricesCone()
default destructor.
CompletelyPositiveMatricesCone()
default constructor.
bool deepCopyFrom(CompletelyPositiveMatricesCone *that)
A function to make a deep copy of an instance of this class.
virtual std::string getConeName()
virtual std::string getConeInXML()
Write a CompletelyPositiveMatricesCone object in XML format.
bool IsEqual(CompletelyPositiveMatricesCone *that)
A function to check for the equality of two objects.
The in-memory representation of a generic cone Specific cone types are derived from this generic clas...
int numberOfOtherIndexes
Cones can also be formed by Multidimensional tensors.
virtual std::string getConeInXML()=0
Write a Cone object in XML format.
std::string name
The cone can have a name for easier identification.
int idx
cones are referenced by an (automatically created) index
bool IsEqual(Cone *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
ENUM_CONE_TYPE coneType
The type of the cone.
bool deepCopyFrom(Cone *that)
A function to make a deep copy of an instance of this class.
virtual std::string getConeName()
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
Cone()
The Cone class constructor.
virtual ~Cone()
The Cone class destructor.
The in-memory representation of the <cones> element.
~Cones()
The Cones class destructor.
Cone ** cone
cone is pointer to an array of Cone object pointers
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
bool IsEqual(Cones *that)
A function to check for the equality of two objects.
Cones()
The Cones class constructor.
bool deepCopyFrom(Cones *that)
A function to make a deep copy of an instance of this class.
int numberOfCones
numberOfCones is the number of <nl> elements in the <cones> element.
The in-memory representation of the <con> element.
double constant
constant is a value that is added to the constraint
double ub
ub is the upper bound on the constraint
bool IsEqual(Constraint *that)
A function to check for the equality of two objects.
double lb
lb is the lower bound on the constraint
Constraint()
The Constraint class constructor.
~Constraint()
The Constraint class destructor.
std::string name
name is the name of the constraint
The in-memory representation of the <constraints> element.
int numberOfConstraints
numberOfConstraints is the number of constraints in the instance
Constraint ** con
con is pointer to an array of Constraint object pointers
~Constraints()
The Constraints class destructor.
Constraints()
The Constraints class constructor.
bool IsEqual(Constraints *that)
A function to check for the equality of two objects.
The CopositiveMatricesCone Class.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
CopositiveMatricesCone()
default constructor.
bool deepCopyFrom(CopositiveMatricesCone *that)
A function to make a deep copy of an instance of this class.
bool IsEqual(CopositiveMatricesCone *that)
A function to check for the equality of two objects.
~CopositiveMatricesCone()
default destructor.
virtual std::string getConeName()
virtual std::string getConeInXML()
Write a CopositiveMatricesCone object in XML format.
a double vector data structure
The in-memory representation of a dual cone.
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
int referenceConeIdx
Dual cones use a reference to another, previously defined cone.
~DualCone()
The DualCone class destructor.
virtual std::string getConeName()
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
int idx
cones are referenced by an (automatically created) index
bool IsEqual(DualCone *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
bool deepCopyFrom(DualCone *that)
A function to make a deep copy of an instance of this class.
DualCone()
The DualCone class constructor.
a sparse matrix data structure for matrices that can hold nonconstant values and have block structure...
a sparse matrix data structure for matrices that can hold nonconstant values
The in-memory representation of the <instanceData> element.
Cones * cones
cones is a pointer to a Cones object
Objectives * objectives
objectives is a pointer to a Objectives object
Constraints * constraints
constraints is a pointer to a Constraints object
Variables * variables
variables is a pointer to a Variables object
MatrixProgramming * matrixProgramming
matrixProgramming is a pointer to a MatrixProgramming object
QuadraticCoefficients * quadraticCoefficients
quadraticCoefficients is a pointer to a QuadraticCoefficients object
LinearConstraintCoefficients * linearConstraintCoefficients
linearConstraintCoefficients is a pointer to a LinearConstraintCoefficients object
TimeDomain * timeDomain
timeDomain is a pointer to a TimeDomain object
bool IsEqual(InstanceData *that)
A function to check for the equality of two objects.
InstanceData()
The InstanceData class constructor.
Matrices * matrices
matrices is a pointer to a Matrices object
~InstanceData()
The InstanceData class destructor.
NonlinearExpressions * nonlinearExpressions
nonlinearExpressions is a pointer to a NonlinearExpressions object
an integer Vector data structure
The in-memory representation of an intersection cone.
~IntersectionCone()
The IntersectionCone class destructor.
bool deepCopyFrom(IntersectionCone *that)
A function to make a deep copy of an instance of this class.
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
virtual std::string getConeName()
IntersectionCone()
The IntersectionCone class constructor.
bool IsEqual(IntersectionCone *that)
A function to check for the equality of two objects.
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
int idx
cones are referenced by an (automatically created) index
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
IntVector * components
the list of components contributing to the intersection each component contains a reference to a prev...
virtual std::string getConeInXML()
Write an IntersectionCone object in XML format.
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
The in-memory representation of the <linearConstraintCoefficients> element.
int iNumberOfStartElements
iNumberOfStartElements counts the number of elements in the <start> section of <linearConstraintCoeff...
int numberOfValues
numberOfValues is the number of nonzero elements stored in the <linearConstraintCoefficients> element
~LinearConstraintCoefficients()
The LinearConstraintCoefficients class destructor.
bool IsEqual(LinearConstraintCoefficients *that)
A function to check for the equality of two objects.
IntVector * start
a pointer to the start of each row or column stored in sparse format
IntVector * colIdx
a pointer of column indices if the problem is stored by row
IntVector * rowIdx
a pointer of row indices if the problem is stored by column
LinearConstraintCoefficients()
The LinearConstraintCoefficients class constructor.
DoubleVector * value
a pointer to the array of nonzero values being stored
The in-memory representation of the <matrices> element.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
bool IsEqual(Matrices *that)
A function to check for the equality of two objects.
~Matrices()
The Matrices class destructor.
int numberOfMatrices
numberOfMatrices is the number of <nl> elements in the <matrices> element.
OSMatrix ** matrix
matrix is a pointer to an array of OSMatrix object pointers
Matrices()
The Matrices class constructor.
bool deepCopyFrom(Matrices *that)
A function to make a deep copy of an instance of this class.
The in-memory representation of the <matrixCon> element.
MatrixCon()
The MatrixCon class constructor.
int numberOfColumns
numberOfColumns gives the number of columns of this matrix
~MatrixCon()
The MatrixCon class destructor.
std::string name
an optional name to this MatrixCon
int lbConeIdx
lbConeIdx gives a cone that must contain matrixCon - lbMatrix
int ubConeIdx
ubConeIdx gives a cone that must contain ubMatrix - matrixCon
int lbMatrixIdx
lbMatrixIdx gives a lower bound for this matrixCon
int numberOfRows
numberOfRows gives the number of rows of this matrix
int templateMatrixIdx
templateMatrixIdx refers to a matrix that describes the locations in this matrixVar that are allowed ...
bool IsEqual(MatrixCon *that)
A function to check for the equality of two objects.
int conReferenceMatrixIdx
conReferenceMatrixIdx allows some or all of the components of this matrixCon to be copied from constr...
int ubMatrixIdx
ubMatrixIdx gives an upper bound for this matrixCon
The in-memory representation of the <matrixConstraints> element.
~MatrixConstraints()
The MatrixConstraints class destructor.
int numberOfMatrixCon
numberOfMatrixCon gives the number of <matrixCon> children
bool IsEqual(MatrixConstraints *that)
A function to check for the equality of two objects.
MatrixConstraints()
The MatrixConstraints class constructor.
MatrixCon ** matrixCon
matrixCon is an array of pointers to the <matrixCon> children
Used to hold the instance in memory.
The in-memory representation of the <expr> element, which is like a nonlinear expression,...
int idx
idx holds the row index of the nonlinear expression
bool IsEqual(MatrixExpression *that)
A function to check for the equality of two objects.
MatrixExpressionTree * matrixExpressionTree
matrixExpressionTree contains the root of the MatrixExpressionTree
~MatrixExpression()
The MatrixExpression class destructor.
bool m_bDeleteExpressionTree
if m_bDeleteExpressionTree is true during garbage collection, we should delete the osExpression tree ...
MatrixExpression()
The MatrixExpression class constructor.
ENUM_NL_EXPR_SHAPE shape
shape holds the shape of the nonlinear expression (linear/quadratic/convex/general) (see further up i...
The in-memory representation of the <matrixExpressions> element.
int numberOfExpr
numberOfExpr gives the number of expressions
bool IsEqual(MatrixExpressions *that)
A function to check for the equality of two objects.
MatrixExpressions()
The MatrixExpressions class constructor.
MatrixExpression ** expr
a pointer to an array of linear and nonlinear expressions that evaluate to matrices
~MatrixExpressions()
The MatrixExpressions class destructor.
a generic class from which we derive matrix constructors (BaseMatrix, MatrixElements,...
The in-memory representation of the <matrixObj> element.
int numberOfColumns
numberOfColumns gives the number of columns of this matrix
int numberOfRows
numberOfRows gives the number of rows of this matrix
bool IsEqual(MatrixObj *that)
A function to check for the equality of two objects.
int orderConeIdx
orderConeIdx gives a cone that expresses preferences during the optimization x is (weakly) preferred ...
MatrixObj()
The MatrixVar class constructor.
int constantMatrixIdx
constantMatrixIdx gives a constant added to the matrixObj
~MatrixObj()
The MatrixVar class destructor.
int templateMatrixIdx
templateMatrixIdx refers to a matrix that describes the locations in this matrixObj that are allowed ...
std::string name
an optional name to this matrixObj
int objReferenceMatrixIdx
objReferenceMatrixIdx allows some or all of the components of this matrixObj to be copied from object...
The in-memory representation of the <matrixObjectives> element.
~MatrixObjectives()
The MatrixObjectives class destructor.
bool IsEqual(MatrixObjectives *that)
A function to check for the equality of two objects.
MatrixObjectives()
The MatrixObjectives class constructor.
int numberOfMatrixObj
numberOfMatrixObj gives the number of <matrixObj> children
MatrixObj ** matrixObj
matrixObj is an array of pointers to the <matrixObj> children
The in-memory representation of the <matrixProgramming> element.
MatrixObjectives * matrixObjectives
a pointer to the matrixObjectives object
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
~MatrixProgramming()
The MatrixProgramming class destructor.
bool deepCopyFrom(MatrixProgramming *that)
A function to make a deep copy of an instance of this class.
MatrixProgramming()
The MatrixProgramming class constructor.
MatrixConstraints * matrixConstraints
a pointer to the matrixConstraints object
bool IsEqual(MatrixProgramming *that)
A function to check for the equality of two objects.
MatrixExpressions * matrixExpressions
a pointer to the matrixExpressions object
MatrixVariables * matrixVariables
a pointer to the matrixVariables object
The in-memory representation of the <matrixVar> element.
int ubConeIdx
ubConeIdx gives a cone that must contain ubMatrix - matrixVar
bool IsEqual(MatrixVar *that)
A function to check for the equality of two objects.
char varType
an optional variable type (C, B, I, D, J, S).
int lbMatrixIdx
lbMatrixIdx gives a lower bound for this matrixVar
~MatrixVar()
The MatrixVar class destructor.
std::string name
an optional name to this matrixVar
int lbConeIdx
lbConeIdx gives a cone that must contain matrixVar - lbMatrix
int numberOfRows
numberOfRows gives the number of rows of this matrix
int varReferenceMatrixIdx
varReferenceMatrixIdx allows some or all of the components of this matrix variable to be copied from ...
int numberOfColumns
numberOfColumns gives the number of columns of this matrix
MatrixVar()
The MatrixVar class constructor.
int ubMatrixIdx
ubMatrixIdx gives an upper bound for this matrixVar
int templateMatrixIdx
templateMatrixIdx refers to a matrix that describes the locations in this matrixVar that are allowed ...
The in-memory representation of the <matrixVariables> element.
MatrixVariables()
The MatrixVariables class constructor.
MatrixVar ** matrixVar
matrixVar is an array of pointers to the <matrixVar> children
bool IsEqual(MatrixVariables *that)
A function to check for the equality of two objects.
~MatrixVariables()
The MatrixVariables class destructor.
int numberOfMatrixVar
numberOfMatrixVar gives the number of <matrixVar> children
The in-memory representation of the <nl> element.
int idx
idx holds the row index of the nonlinear expression
ScalarExpressionTree * osExpressionTree
osExpressionTree contains the root of the ScalarExpressionTree
ENUM_NL_EXPR_SHAPE shape
shape holds the shape of the nonlinear expression (linear/quadratic/convex/general) (see further up i...
bool IsEqual(Nl *that)
A function to check for the equality of two objects.
bool m_bDeleteExpressionTree
m_bDeleteExpressionTree is true, if in garbage collection, we should delete the osExpression tree obj...
The in-memory representation of the <nonlinearExpressions> element.
~NonlinearExpressions()
The NonlinearExpressions class destructor.
Nl ** nl
nl is pointer to an array of Nl object pointers
int numberOfNonlinearExpressions
numberOfNonlinearExpressions is the number of <nl> elements in the <nonlinearExpressions> element.
NonlinearExpressions()
The NonlinearExpressions class constructor.
bool IsEqual(NonlinearExpressions *that)
A function to check for the equality of two objects.
The NonnegativeCone Class.
virtual std::string getConeInXML()
Write a NonnegativeCone object in XML format.
virtual std::string getConeName()
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
bool deepCopyFrom(NonnegativeCone *that)
A function to make a deep copy of an instance of this class.
bool IsEqual(NonnegativeCone *that)
A function to check for the equality of two objects.
NonnegativeCone()
default constructor.
~NonnegativeCone()
default destructor.
The NonpositiveCone Class.
bool IsEqual(NonpositiveCone *that)
A function to check for the equality of two objects.
virtual std::string getConeName()
virtual std::string getConeInXML()
Write a NonpositiveCone object in XML format.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
bool deepCopyFrom(NonpositiveCone *that)
A function to make a deep copy of an instance of this class.
~NonpositiveCone()
default destructor.
NonpositiveCone()
default constructor.
The in-memory representation of an OSiL instance.
bool getIterateResults(double *x, double *objLambda, double *conLambda, bool new_x, int highestOrder)
end revised AD code
int getNumberOfColumnsForMatrix(int n)
Get the number of blocks in the matrix.
bool setTimeDomain(std::string format)
This sets the format of the time domain ("stages"/"interval"/"none")
std::string getTimeDomainFormat()
Get the format of the time domain ("stages"/"interval")
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int maxDegree, int numberOfUB, double *ub, int numberOfLB, double *lb, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
int * getQuadraticRowIndexes()
Get the indexes of rows which have a quadratic term.
SparseMatrix * getLinearConstraintCoefficientsInRowMajor()
Get linear constraint coefficients in row major.
SparseHessianMatrix * getLagrangianHessianSparsityPattern()
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int numberOfComponents, int *components, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
std::vector< ExprNode * > getMatrixExpressionTreeInPrefix(int rowIdx)
Get the prefix tokens for a given row index.
int getNumberOfQuadraticTerms()
Get the number of specified (usually nonzero) qTerms in the quadratic coefficients.
bool setInstanceLicence(std::string licence)
set the instance licence.
Nl ** getNonlinearExpressions()
Get the pointers to the roots of all expression trees.
double * getObjectiveConstants()
Get objective constants.
std::string * getVariableNames()
Get variable names.
bool copyLinearConstraintCoefficients(int numberOfValues, bool isColumnMajor, double *values, int valuesBegin, int valuesEnd, int *indexes, int indexesBegin, int indexesEnd, int *starts, int startsBegin, int startsEnd)
copy linear constraint coefficients: perform a deep copy of the sparse matrix
bool setConstraintNumber(int number)
set the number of constraints.
std::vector< ExprNode * > getMatrixExpressionTreeInPostfix(int rowIdx)
Get the postfix tokens for a given row index.
SparseVector * calculateConstraintFunctionGradient(double *x, int idx, bool new_x)
Calculate the gradient of the constraint function indexed by idx this function is overloaded.
bool setTimeDomainStages(int number, std::string *names)
This sets the number (and optionally names) of the time stages.
bool matrixHasBase(int n)
Several tools to parse the constructor list of a matrix.
bool bVariablesModified
bVariablesModified is true if the variables data has been modified.
bool setInstanceCreator(std::string fileCreator)
set the instance creator.
double * calculateAllObjectiveFunctionValues(double *x, double *objLambda, double *conLambda, bool new_x, int highestOrder)
Calculate all of the objective function values.
bool matrixHasTransformations(int n)
GeneralSparseMatrix * getMatrixBlockInColumnMajorForm(int n, int columnIdx, int rowIdx)
Get the (nonzero) elements of the matrix in symmetric block form.
int getNumberOfBlocksConstructors(int n)
bool bObjectivesModified
bObjectivesModified is true if the objective function data has been modified.
int getADSparsityHessian()
end revised AD code
std::string printModel(int rowIdx)
Print the infix representation of the row (which could be an an objective function row) indexed by ro...
bool addQTermsToExressionTree()
bool addVariable(int index, std::string name, double lowerBound, double upperBound, char type)
add a variable.
bool bAMatrixModified
bAMatrixModified is true if the A matrix data has been modified.
bool setTimeDomainStageConstraintsUnordered(int numberOfStages, int *numberOfConstraints, int **conIndex)
This sets the constraints associated with each time domain stage in srbitrary order.
std::string printModel()
Print the infix representation of the problem.
int * getTimeDomainStageNumberOfVariables()
Get the number of variables contained in each time stage.
int getNumberOfNonlinearExpressionTreeIndexes()
Get the number of unique nonlinear expression tree indexes.
int getNumberOfNonlinearExpressionTreeModIndexes()
Get the number of unique nonlinear expression tree indexes after modifying the expression tree to con...
bool getZeroOrderResults(double *x, double *objLambda, double *conLambda)
Calculate function values.
int getTimeDomainStageNumber()
Get the number of stages that make up the time domain.
int getNumberOfIntegerVariables()
getNumberOfIntegerVariables
bool getSparseJacobianFromColumnMajor()
std::string getInstanceName()
Get instance name.
OSMatrix * getMatrix(int n)
Get the list of constructors of the matrix.
bool bUseExpTreeForFunEval
bUseExpTreeForFunEval is set to true if you wish to use the OS Expression Tree for function evaluatio...
ScalarExpressionTree * getLagrangianExpTree()
bool setNumberOfQuadraticTerms(int nq)
set the number of quadratic terms
bool setConeNumber(int number)
set the number of cones
bool getFirstOrderResults(double *x, double *objLambda, double *conLambda)
Calculate first derivatives.
bool addConstraint(int index, std::string name, double lowerBound, double upperBound, double constant)
add a constraint.
double getTimeDomainIntervalHorizon()
Get the horizon for the time domain interval.
int getNumberOfBinaryVariables()
getNumberOfBinaryVariables
std::string getInstanceLicence()
Get instance licence.
double * getConstraintLowerBounds()
Get constraint lower bounds.
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int distortionMatrixIdx, double normFactor, int axisDirection, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
int getNumberOfNonlinearObjectives()
bool setQuadraticTermsInNonlinearExpressions(int number, int *rowIndexes, int *varOneIndexes, int *varTwoIndexes, double *coefficients)
set quadratic terms in nonlinearExpressions
std::string * getTimeDomainStageNames()
Get the names of the stages (NULL or empty string ("") if a stage has not been given a name.
bool setNonlinearExpressions(int nexpr, Nl **root)
set nonlinear expressions
SparseJacobianMatrix * getJacobianSparsityPattern()
bool matrixHasElements(int n)
ScalarExpressionTree * getNonlinearExpressionTreeMod(int rowIdx)
Get the expression tree for a given row index for the modified expression trees (quadratic terms adde...
bool getLinearConstraintCoefficientMajor()
Get whether the constraint coefficients is in column major (true) or row major (false).
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
ENUM_MATRIX_TYPE getMatrixType(int n)
Get the matrix type.
std::vector< double > reverseAD(int p, std::vector< double > vdlambda)
Perform an AD reverse sweep.
bool initObjGradients()
This should be called by initForAlgDiff()
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int referenceIdx, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
std::string getInstanceDescription()
Get instance description.
int getNumberOfMatrixVariables()
Get the number of matrix variables.
std::vector< ExprNode * > getNonlinearExpressionTreeModInPostfix(int rowIdx)
Get the postfix tokens for a given row index for the modified Expression Tree (quadratic terms added)...
int getConstraintNumber()
Get number of constraints.
int ** getTimeDomainStageObjList()
Get the list of objectives in each stage.
double * getVariableLowerBounds()
Get variable lower bounds.
double * calculateAllConstraintFunctionValues(double *x, double *objLambda, double *conLambda, bool new_x, int highestOrder)
Calculate all of the constraint function values.
bool setQuadraticCoefficients(int number, int *rowIndexes, int *varOneIndexes, int *varTwoIndexes, double *coefficients, int begin, int end)
set quadratic coefficients into the QuadraticCoefficients->qTerm data structure
int getNumberOfMatrixExpressionTreeIndexes()
Get the number of unique matrix expression tree indexes.
char * getVariableTypes()
Get variable initial values.
int getNumberOfStringVariables()
getNumberOfStringVariables
double ** calculateAllObjectiveFunctionGradients(double *x, double *objLambda, double *conLambda, bool new_x, int highestOrder)
Calculate the gradient of all objective functions.
bool bConstraintsModified
bConstraintsModified is true if the constraints data has been modified.
int * getMatrixExpressionTreeIndexes()
Get all the matrix expression tree indexes, i.e.
std::map< int, MatrixExpressionTree * > getAllMatrixExpressionTreesMod()
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int distortionMatrixIdx, double normFactor, int firstAxisDirection, int secondAxisDirection, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
int getLinearConstraintCoefficientNumber()
Get number of specified (usually nonzero) linear constraint coefficient values.
int getNumberOfSemiIntegerVariables()
getNumberOfSemiIntegerVariables
bool addMatrix(int index, std::string name, int numberOfRows, int numberOfColumns, ENUM_MATRIX_SYMMETRY symmetry, ENUM_MATRIX_TYPE matrixType, unsigned int inumberOfChildren, MatrixNode **m_mChildren)
add a matrix.
std::vector< ExprNode * > getNonlinearExpressionTreeModInPrefix(int rowIdx)
Get the prefix tokens for a given row index for the modified Expression Tree (quadratic terms added).
int getNumberOfMatrixConstraints()
Get the number of matrix constraints.
double calculateFunctionValue(int idx, double *x, bool new_x)
Calculate the function value for function (constraint or objective) indexed by idx.
double getTimeDomainIntervalStart()
Get the start for the time domain interval.
std::string * getObjectiveMaxOrMins()
Get objective maxOrMins.
std::vector< ExprNode * > getNonlinearExpressionTreeInPrefix(int rowIdx)
Get the prefix tokens for a given row index.
SparseVector ** getObjectiveCoefficients()
Get objective coefficients.
int getNumberOfValuesForMatrix(int n)
Get the number of (nonzero) values in the matrix.
bool matrixHasBlocks(int n)
std::vector< ExprNode * > getNonlinearExpressionTreeInPostfix(int rowIdx)
Get the postfix tokens for a given row index.
int getNumberOfQuadraticRowIndexes()
Get the number of rows which have a quadratic term.
ENUM_MATRIX_SYMMETRY getMatrixSymmetry(int n)
Get the matrix symmetry.
bool getSparseJacobianFromRowMajor()
GeneralSparseMatrix * getMatrixCoefficientsInColumnMajor(int n)
Get the (nonzero) elements of the matrix in column major form.
std::map< int, ScalarExpressionTree * > getAllNonlinearExpressionTreesMod()
SparseHessianMatrix * calculateHessian(double *x, int idx, bool new_x)
Calculate the Hessian of a constraint or objective function.
ScalarExpressionTree * getNonlinearExpressionTree(int rowIdx)
Get the expression tree for a given row index.
int getNumberOfSemiContinuousVariables()
getNumberOfSemiContinuousVariables
int getMatrixNumber()
Get the number of matrices.
bool setTimeDomainStageConstraintsOrdered(int numberOfStages, int *numberOfConstraints, int *startIdx)
This sets the constraints associated with each time domain stage in temporal order.
bool setVariables(int number, std::string *names, double *lowerBounds, double *upperBounds, char *types)
set all the variable related elements.
bool createOSADFun(std::vector< double > vdX)
Create the a CppAD Function object: this is a function where the domain is the set of variables for t...
int * getNonlinearExpressionTreeModIndexes()
Get all the nonlinear expression tree indexes, i.e., indexes of rows (objectives or constraints) that...
std::vector< ExprNode * > getMatrixExpressionTreeModInPostfix(int rowIdx)
Get the postfix tokens for a given row index for the modified Expression Tree (quadratic terms added)...
bool setTimeDomainStageVariablesOrdered(int numberOfStages, int *numberOfVariables, int *startIdx)
This sets the variables associated with each time domain stage in temporal order.
bool setInstanceSource(std::string source)
set the instance source.
bool setTimeDomainStageVariablesUnordered(int numberOfStages, int *numberOfVariables, int **varIndex)
This sets the variables associated with each time domain stage in srbitrary order.
int ** getTimeDomainStageVarList()
Get the list of variables in each stage.
bool initForAlgDiff()
This should be called by nonlinear solvers using callback functions.
double * calculateAllConstraintFunctionValues(double *x, bool new_x)
Calculate all of the constraint function values, we are overloading this function and this version of...
GeneralFileHeader * instanceHeader
the instanceHeader is implemented as a general file header object to allow sharing of classes between...
SparseJacobianMatrix * calculateAllConstraintFunctionGradients(double *x, double *objLambda, double *conLambda, bool new_x, int highestOrder)
Calculate the gradient of all constraint functions.
std::string getInstanceSource()
Get instance source.
double * calculateObjectiveFunctionGradient(double *x, int objIdx, bool new_x)
Calculate the gradient of the objective function indexed by objIdx this function is overloaded.
std::map< int, int > getAllNonlinearVariablesIndexMap()
char * getConstraintTypes()
Get constraint types.
bool setLinearConstraintCoefficients(int numberOfValues, bool isColumnMajor, double *values, int valuesBegin, int valuesEnd, int *indexes, int indexesBegin, int indexesEnd, int *starts, int startsBegin, int startsEnd)
set linear constraint coefficients
int getNumberOfElementConstructors(int n)
double * getConstraintUpperBounds()
Get constraint upper bounds.
OSInstance()
The OSInstance class constructor.
SparseVector * calculateConstraintFunctionGradient(double *x, double *objLambda, double *conLambda, int idx, bool new_x, int highestOrder)
Calculate the gradient of the constraint function indexed by idx.
int * getTimeDomainStageNumberOfObjectives()
Get the number of objectives contained in each time stage.
double * getConstraintConstants()
Get constraint constants.
std::string * getConstraintNames()
Get constraint names.
std::string getMatrixExpressionTreeInInfix(int rowIdx)
Get the infix representation for a given row (or objective function) index.
int getNumberOfNonlinearExpressions()
Get number of nonlinear expressions.
InstanceData * instanceData
A pointer to an InstanceData object.
double ** getDenseObjectiveCoefficients()
getDenseObjectiveCoefficients.
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, std::string semidefiniteness, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
double * getObjectiveWeights()
Get objective weights.
std::map< int, MatrixExpressionTree * > getAllMatrixExpressionTrees()
SparseHessianMatrix * calculateLagrangianHessian(double *x, double *objLambda, double *conLambda, bool new_x, int highestOrder)
Calculate the Hessian of the Lagrangian Expression Tree This method will build the CppAD expression t...
int * getObjectiveCoefficientNumbers()
Get objective coefficient number.
double * calculateAllObjectiveFunctionValues(double *x, bool new_x)
Calculate all of the objective function values, we are overloading this function and this version of ...
int getNumberOfMatrixObjectives()
Get the number of matrix objectives.
QuadraticTerms * getQuadraticTerms()
Get all the quadratic terms in the instance.
int getVariableNumber()
Get number of variables.
double * getVariableUpperBounds()
Get variable upper bounds.
std::map< int, ScalarExpressionTree * > getAllNonlinearExpressionTrees()
~OSInstance()
The OSInstance class destructor.
bool setTimeDomainStageObjectivesOrdered(int numberOfStages, int *numberOfObjectives, int *startIdx)
This sets the objectives associated with each time domain stage in temporal order.
bool setInstanceDescription(std::string description)
set the instance description.
bool setTimeDomainInterval(double start, double horizon)
This sets the start and end of the time interval.
int * getNonlinearExpressionTreeIndexes()
Get all the nonlinear expression tree indexes, i.e., indexes of rows (objectives or constraints) that...
bool setObjectives(int number, std::string *names, std::string *maxOrMins, double *constants, double *weights, SparseVector **objectitiveCoefficients)
set all the objectives related elements.
int getNumberOfRowsForMatrix(int n)
Get the number of rows in the matrix.
bool setTimeDomainStageObjectivesUnordered(int numberOfStages, int *numberOfObjectives, int **varIndex)
This sets the objectives associated with each time domain stage in arbitrary order.
MatrixExpression ** getMatrixExpressions()
Get the pointers to the roots of all matrix expression trees.
double * calculateObjectiveFunctionGradient(double *x, double *objLambda, double *conLambda, int objIdx, bool new_x, int highestOrder)
Calculate the gradient of the objective function indexed by objIdx.
MatrixExpressionTree * getMatrixExpressionTree(int rowIdx)
Get the matrix expression tree for a given row index.
int getNumberOfTransformationConstructors(int n)
int getNumberOfMatrixExpressions()
Get the number of matrix-valued expressions.
std::string * getObjectiveNames()
Get objective names.
bool addQTermsToExpressionTree()
This method adds quadratic terms into the array of expression trees.
std::string getInstanceCreator()
Get instance fileCreator.
bool setInstanceName(std::string name)
set the instance name.
bool addObjective(int index, std::string name, std::string maxOrMin, double constant, double weight, SparseVector *objectiveCoefficients)
add an objective.
bool setConstraints(int number, std::string *names, double *lowerBounds, double *upperBounds, double *constants)
set all the constraint related elements.
bool setObjectiveNumber(int number)
set the number of objectives.
int ** getTimeDomainStageConList()
Get the list of constraints in each stage.
std::string getNonlinearExpressionTreeInInfix(int rowIdx)
Get the infix representation for a given row (or objective function) index.
bool setMatrixNumber(int number)
set the number of matrices
bool setVariableNumber(int number)
set the number of variables.
bool addCone(int index, int numberOfRows, int numberOfColumns, ENUM_CONE_TYPE coneType, std::string name, int distortionMatrixIdx, double normFactor, int axisDirection, double pNorm, int numberOfOtherIndexes=0, int *otherIndexes=NULL)
add a cone.
bool initializeNonLinearStructures()
Initialize the data structures for the nonlinear API.
int getObjectiveNumber()
Get number of objectives.
int * getTimeDomainStageNumberOfConstraints()
Get the number of constraints contained in each time stage.
bool getSecondOrderResults(double *x, double *objLambda, double *conLambda)
Calculate second derivatives.
GeneralSparseMatrix * getMatrixCoefficientsInRowMajor(int n)
Get the (nonzero) elements of the matrix in row major form.
SparseMatrix * getLinearConstraintCoefficientsInColumnMajor()
Get linear constraint coefficients in column major.
bool IsEqual(OSInstance *that)
A function to check for the equality of two objects.
std::string getMatrixName(int n)
Get the name of the matrix.
int getNumberOfNonlinearConstraints()
void duplicateExpressionTreesMap()
duplicate the map of expression trees.
std::vector< double > forwardAD(int p, std::vector< double > vdX)
Perform an AD forward sweep.
a data structure to represent a matrix object (derived from MatrixType)
The OSnLMNode Class for nonlinear expressions involving matrices.
The in-memory representation of the objective function <coef> element.
bool IsEqual(ObjCoef *that)
A function to check for the equality of two objects.
double value
value is the value of the objective function coefficient corresponding to the variable with index idx
ObjCoef()
The ObjCoef class constructor.
int idx
idx is the index of the variable corresponding to the coefficient
~ObjCoef()
The ObjCoef class destructor.
The in-memory representation of the <obj> element.
ObjCoef ** coef
coef is pointer to an array of ObjCoef object pointers
double constant
constant is the constant term added to the objective function, 0 by default
double weight
weight is the weight applied to the given objective function, 1.0 by default
bool IsEqual(Objective *that)
A function to check for the equality of two objects.
int numberOfObjCoef
numberOfObjCoef is the number of variables with a nonzero objective function coefficient
~Objective()
The Objective class destructor.
Objective()
The Objective class constructor.
std::string name
the name of the objective function
std::string maxOrMin
declare the objective function to be a max or a min
The in-memory representation of the <objectives> element.
bool IsEqual(Objectives *that)
A function to check for the equality of two objects.
Objective ** obj
coef is pointer to an array of ObjCoef object pointers
int numberOfObjectives
numberOfObjectives is the number of objective functions in the instance
Objectives()
The Objectives class constructor.
~Objectives()
The Objectives class destructor.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
OrthantCone()
default constructor.
~OrthantCone()
default destructor.
bool IsEqual(OrthantCone *that)
A function to check for the equality of two objects.
virtual std::string getConeInXML()
Write an OrthantCone object in XML format.
virtual std::string getConeName()
bool deepCopyFrom(OrthantCone *that)
A function to make a deep copy of an instance of this class.
double * ub
For each dimension of the cone, give the upper and lower bounds The upper bound can be only zero or +...
The in-memory representation of a polar cone.
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
bool IsEqual(PolarCone *that)
A function to check for the equality of two objects.
int referenceConeIdx
Polar cones use a reference to another, previously defined cone.
PolarCone()
The PolarCone class constructor.
int idx
cones are referenced by an (automatically created) index
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
virtual std::string getConeName()
~PolarCone()
The PolarCone class destructor.
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
bool deepCopyFrom(PolarCone *that)
A function to make a deep copy of an instance of this class.
The in-memory representation of a polyhedral cone.
bool deepCopyFrom(PolyhedralCone *that)
A function to make a deep copy of an instance of this class.
int idx
cones are referenced by an (automatically created) index
~PolyhedralCone()
The PolyhedralCone class destructor.
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
bool IsEqual(PolyhedralCone *that)
A function to check for the equality of two objects.
PolyhedralCone()
The PolyhedralCone class constructor.
virtual std::string getConeName()
int referenceMatrixIdx
Polyhedral cones use a reference to a previously defined matrix for the extreme rays.
virtual std::string getConeInXML()
Write a PolyhedralCone object in XML format.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
The in-memory representation of a product cone.
virtual std::string getConeInXML()
Write a ProductCone object in XML format.
~ProductCone()
The ProductCone class destructor.
IntVector * factors
the list of "factors" contributing to the product each factor contains a reference to a previously de...
virtual std::string getConeName()
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
ProductCone()
The ProductCone class constructor.
bool deepCopyFrom(ProductCone *that)
A function to make a deep copy of an instance of this class.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
bool IsEqual(ProductCone *that)
A function to check for the equality of two objects.
int idx
cones are referenced by an (automatically created) index
The in-memory representation of the <quadraticCoefficients> element.
QuadraticTerm ** qTerm
qTerm is a pointer to an array of QuadraticTerm object pointers
bool IsEqual(QuadraticCoefficients *that)
A function to check for the equality of two objects.
QuadraticCoefficients()
The QuadraticCoefficients class constructor.
int numberOfQuadraticTerms
numberOfQuadraticTerms is the number of quadratic terms in the <quadraticCoefficients> element.
~QuadraticCoefficients()
The QuadraticCoefficients class destructor.
The in-memory representation of a quadratic cone.
bool deepCopyFrom(QuadraticCone *that)
A function to make a deep copy of an instance of this class.
virtual std::string getConeName()
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
~QuadraticCone()
The QuadraticCone class destructor.
int axisDirection
The index of the first component can be changed Since there are possibly many dimensions,...
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
bool IsEqual(QuadraticCone *that)
A function to check for the equality of two objects.
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
int idx
cones are referenced by an (automatically created) index
QuadraticCone()
The QuadraticCone class constructor.
double normScaleFactor
quadratic cones normally are of the form x0 >= x1^2 + x2^2 + ...
virtual std::string getConeInXML()
Write a QuadraticCone object in XML format.
The in-memory representation of the <qTerm> element.
double coef
coef is the coefficient of the quadratic term
int idxOne
idxOne is the index of the first variable in the quadratic term
~QuadraticTerm()
The QuadraticTerm class destructor.
QuadraticTerm()
The QuadraticTerm class constructor.
bool IsEqual(QuadraticTerm *that)
A function to check for the equality of two objects.
int idx
idx is the index of the row in which the quadratic term appears
int idxTwo
idxTwo is the index of the second variable in the quadratic term
a data structure for holding quadratic terms
The in-memory representation of a rotated quadratic cone.
virtual std::string getConeInXML()
Write a RotatedQuadraticCone object in XML format.
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
bool IsEqual(RotatedQuadraticCone *that)
A function to check for the equality of two objects.
~RotatedQuadraticCone()
The RotatedQuadraticCone class destructor.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
double normScaleFactor
rotated quadratic cones normally are of the form x0x1 >= x2^2 + x3^2 + ...
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
int idx
cones are referenced by an (automatically created) index
bool deepCopyFrom(RotatedQuadraticCone *that)
A function to make a deep copy of an instance of this class.
virtual std::string getConeName()
RotatedQuadraticCone()
The RotatedQuadraticCone class constructor.
int firstAxisDirection
The indices of the first two component can be changed Since there are possibly many dimensions,...
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
Used to hold part of the instance in memory.
The in-memory representation of a cone of semidefinite matrices.
~SemidefiniteCone()
The SemidefiniteCone class destructor.
bool isPositiveSemiDefinite
information about semidefiniteness is also tracked in a boolean variable
int coneType
The type of the cone (one of the values in ENUM_CONE_TYPE)
SemidefiniteCone()
The SemidefiniteCone class constructor.
bool setRandom(double density, bool conformant, int iMin, int iMax)
A function to make a random instance of this class.
int numberOfOtherIndexes
Multidimensional tensors can also form cones (the Kronecker product, for instance,...
int idx
cones are referenced by an (automatically created) index
virtual std::string getConeInXML()
Write a SemidefiniteCone object in XML format.
bool deepCopyFrom(SemidefiniteCone *that)
A function to make a deep copy of an instance of this class.
std::string semidefiniteness
we need to distinguish positive and negative semidefiniteness
int numberOfRows
Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cone...
bool IsEqual(SemidefiniteCone *that)
A function to check for the equality of two objects.
virtual std::string getConeName()
The in-memory representation of a SparseHessianMatrix.
a sparse Jacobian matrix data structure
a sparse matrix data structure
a sparse vector data structure
~TimeDomainInterval()
The Interval class destructor.
double start
start is the start of the planning period in the <interval> element.
double horizon
horizon is the end of the planning period in the <interval> element.
TimeDomainInterval()
The Interval class constructor.
The in-memory representation of the <con> element.
int idx
idx gives the index of this constraint
~TimeDomainStageCon()
The TimeDomainStageCon class destructor.
TimeDomainStageCon()
The TimeDomainStageCon class constructor.
The in-memory representation of the <constraints> child of the <stage> element.
int numberOfConstraints
numberOfConstraints gives the number of constraints contained in this stage
~TimeDomainStageConstraints()
The TimeDomainStageConstraints class destructor.
TimeDomainStageConstraints()
The TimeDomainStageConstraints class constructor.
TimeDomainStageCon ** con
con is a pointer to an array of TimeDomainStageCon object pointers
int startIdx
startdIdx gives the number of the first constraint contained in this stage
The in-memory representation of the <obj> element.
int idx
idx gives the index of this variable
~TimeDomainStageObj()
The TimeDomainStageObj class destructor.
TimeDomainStageObj()
The TimeDomainStageObj class constructor.
The in-memory representation of the <objectives> child of the <stage> element.
int startIdx
startdIdx gives the number of the first objective contained in this stage
TimeDomainStageObjectives()
The TimeDomainStageObjectives class constructor.
int numberOfObjectives
numberOfObjectives gives the number of objectives contained in this stage
TimeDomainStageObj ** obj
obj is a pointer to an array of TimeDomainStageObj object pointers
~TimeDomainStageObjectives()
The TimeDomainStageObjectives class destructor.
The in-memory representation of the element.
TimeDomainStageVar()
The TimeDomainStageVar class constructor.
int idx
idx gives the index of this variable
~TimeDomainStageVar()
The TimeDomainStageVar class destructor.
The in-memory representation of the <variables> child of the <stage> element.
TimeDomainStageVariables()
The TimeDomainStageVariables class constructor.
int numberOfVariables
numberOfVariables gives the number of variables contained in this stage
int startIdx
startdIdx gives the number of the first variable contained in this stage
~TimeDomainStageVariables()
The TimeDomainStageVariables class destructor.
TimeDomainStageVar ** var
var is a pointer to an array of TimeDomainStageVar object pointers
The in-memory representation of the <stage> element.
TimeDomainStageObjectives * objectives
objectives is a pointer to a TimeDomainObjectives object
std::string name
name corresponds to the optional attribute that holds the name of the stage; the default value is emp...
~TimeDomainStage()
The TimeDomainStage class destructor.
TimeDomainStageVariables * variables
variables is a pointer to a TimeDomainVariables object
TimeDomainStageConstraints * constraints
constraints is a pointer to a TimeDomainConstraints object
TimeDomainStage()
The TimeDomainStage class constructor.
The in-memory representation of the <stages> element.
TimeDomainStages()
The Stages class constructor.
int numberOfStages
numberOfStages is the number of stages in the <stages> element.
TimeDomainStage ** stage
stage is pointer to an array of stage object pointers
~TimeDomainStages()
The Stages class destructor.
The in-memory representation of the <timeDomain> element.
TimeDomainStages * stages
stages is a pointer to a Stages object
TimeDomainInterval * interval
interval is a pointer to an Interval object
TimeDomain()
The TimeDomain class constructor.
~TimeDomain()
The TimeDomain class destructor.
The in-memory representation of the variable element.
bool IsEqual(Variable *that)
A function to check for the equality of two objects.
Variable()
The Variable class constructor.
double ub
ub corresponds to the optional attribute that holds the variable upper bound.
std::string name
name corresponds to the optional attribute that holds the variable name, the default value is empty
~Variable()
The Variable class destructor.
double lb
lb corresponds to the optional attribute that holds the variable lower bound.
char type
type corresponds to the attribute that holds the variable type: C (Continuous), B (binary),...
The in-memory representation of the variables element.
bool IsEqual(Variables *that)
A function to check for the equality of two objects.
Variables()
The Variables class constructor.
~Variables()
The Variables class destructor.
int numberOfVariables
numberOfVariables is the number of variables in the instance
Variable ** var
Here we define a pointer to an array of var pointers.