CONOPT
Loading...
Searching...
No Matches
jconopt.ModelData Class Reference

A class that can be extended to build and solve a model using Conopt. More...

Public Member Functions

synchronized void delete ()
 
void swigReleaseOwnership ()
 
void swigTakeOwnership ()
 
 ModelData ()
 
double evaluateNonlinearTerm (double[] x, int rowno, boolean ignerr, int thread)
 callback method for evaluating the nonlinear terms in a given row
 
void evaluateNonlinearJacobian (double[] x, double[] jac, int rowno, int[] jacnum, boolean ignerr, int thread)
 callback method for evaluating the jacobian for the nonlinear terms in a given row
 
void initFDEvaluation (double[] x, int[] rowlist, EvaluationMode mode, int numthread, boolean ignerr)
 callback method for initialising the first derivative evaluation.
 
void endFDEvaluation (boolean ignerr)
 Optional function, if defined, it will be called at the end of the function evaluation stage. This can be used to clean up any user data generated, such as in FDEvalIni, that was used to improve the efficiency of the function and derivative evaluation.
 
void evaluateSDLagrangian (double[] x, double[] u, int[] hessianrow, int[] hessiancol, double[] hessianval)
 Computes and returns the numerical values of the Lagrangian of the Hessian.
 
void evaluateSDDirLagrangian (double[] x, double[] dx, double[] u, double[] d2g, boolean newpoint)
 computes the directional second derivative for the Lagrangian
 
void evaluateDirectionalSD (double[] x, double[] dx, double[] d2g, int rowno, int[] jacnum, int thread)
 computes the directional second derivative for a single constraint
 
void initDirectionalSDEval (double[] x, double[] dx, int[] rowlist, int numthread, boolean newpoint)
 a callback for the initialisation of the second derivative evaluation.
 
void endDirectionalSDEval ()
 called by CONOPT after a sequence of evaluateDirectionalSD() calls each time either the point or the direction changes.
 
void errorInEvaluation ()
 reports that an error occurred in the evaluation.
 
void setProblemDimension (long numvar, long numcons, long numnz, long numnlnz)
 
int addConstraint (ConstraintType constype, double rhs, int slackstatus)
 
int addConstraint (ConstraintType constype, double rhs)
 
int addConstraint (ConstraintType constype, double rhs, int[] varindex, double[] value, int[] nlflag, int slackstatus)
 
int addConstraint (ConstraintType constype, double rhs, int[] varindex, double[] value, int[] nlflag)
 
int addVariable (double lower, double upper, double curr, int varstatus)
 
int addVariable (double lower, double upper, double curr)
 
int addVariable (double lower, double upper)
 
int addVariable (double lower, double upper, int[] consindex, double[] value, int[] nlflag, double curr, int varstatus)
 
int addVariable (double lower, double upper, int[] consindex, double[] value, int[] nlflag, double curr)
 
int addVariable (double lower, double upper, int[] consindex, double[] value, int[] nlflag)
 
void setObjectiveElement (ObjectiveElement elem, int elemindex)
 
void setOptimizationSense (Sense sense)
 
void setInitialStatusOption (int inistat)
 
int numVar ()
 
int numCons ()
 
int numHessianNonzeros ()
 
Variable getVariable (int index)
 
Constraint getConstraint (int index)
 
void setSDEvaluationType (SDEvaluationType sdevaltype)
 
void setSDLagrangianStructure (int[] rownum, int[] colnum)
 
- Public Member Functions inherited from jconopt.ConoptModelData
 ConoptModelData ()
 
int readMatrix (SWIGTYPE_p_double lower, SWIGTYPE_p_double curr, SWIGTYPE_p_double upper, SWIGTYPE_p_int vsta, SWIGTYPE_p_int type, SWIGTYPE_p_double rhs, SWIGTYPE_p_int esta, SWIGTYPE_p_int colsta, SWIGTYPE_p_int rowno, SWIGTYPE_p_double value, SWIGTYPE_p_int nlflag, int numvar, int numcon, int numnz)
 
int[] getSDLagrangianRowNumbers ()
 
int[] getSDLagrangianColumnNumbers ()
 

Protected Member Functions

 ModelData (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 
void swigDirectorDisconnect ()
 
- Protected Member Functions inherited from jconopt.ConoptModelData
 ConoptModelData (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long getCPtr (ModelData obj)
 
static long swigRelease (ModelData obj)
 
- Static Protected Member Functions inherited from jconopt.ConoptModelData
static long getCPtr (ConoptModelData obj)
 
static long swigRelease (ConoptModelData obj)
 

Additional Inherited Members

- Protected Attributes inherited from jconopt.ConoptModelData
transient boolean swigCMemOwn
 

Detailed Description

A class that can be extended to build and solve a model using Conopt.

This class is the base class that is used for the extended interfaces for Conopt, namely Python and Java. The virtual methods included in this class can be redefined in the native languages.

Definition at line 23 of file ModelData.java.

Constructor & Destructor Documentation

◆ ModelData() [1/2]

jconopt.ModelData.ModelData ( long cPtr,
boolean cMemoryOwn )
inlineprotected

Definition at line 26 of file ModelData.java.

◆ ModelData() [2/2]

jconopt.ModelData.ModelData ( )
inline

Definition at line 78 of file ModelData.java.

Member Function Documentation

◆ getCPtr()

static long jconopt.ModelData.getCPtr ( ModelData obj)
inlinestaticprotected

Definition at line 31 of file ModelData.java.

◆ swigRelease()

static long jconopt.ModelData.swigRelease ( ModelData obj)
inlinestaticprotected

Definition at line 35 of file ModelData.java.

◆ finalize()

void jconopt.ModelData.finalize ( )
inlineprotected

Reimplemented from jconopt.ConoptModelData.

Definition at line 48 of file ModelData.java.

◆ delete()

synchronized void jconopt.ModelData.delete ( )
inline

Reimplemented from jconopt.ConoptModelData.

Definition at line 52 of file ModelData.java.

◆ swigDirectorDisconnect()

void jconopt.ModelData.swigDirectorDisconnect ( )
inlineprotected

Reimplemented from jconopt.ConoptModelData.

Definition at line 63 of file ModelData.java.

◆ swigReleaseOwnership()

void jconopt.ModelData.swigReleaseOwnership ( )
inline

Reimplemented from jconopt.ConoptModelData.

Definition at line 68 of file ModelData.java.

◆ swigTakeOwnership()

void jconopt.ModelData.swigTakeOwnership ( )
inline

Reimplemented from jconopt.ConoptModelData.

Definition at line 73 of file ModelData.java.

◆ errorInEvaluation()

void jconopt.ModelData.errorInEvaluation ( )
inline

reports that an error occurred in the evaluation.

When executing evaluateNonlinearTerm() or evaluateNonlinearJacobian() the number of errors are counted and then if an error limit is exceeded, CONOPT will terminate.

When evaluating second derivative information, any errors reported will inform CONOPT that it is unable to use second order methods for the current point.

Definition at line 257 of file ModelData.java.


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