CONOPT
Loading...
Searching...
No Matches

The Conopt class. More...

Public Member Functions

 __init__ (self, *args)
 Constructor.
 
 solve (self)
 method for starting the solving process of CONOPT.
 
 checkModelAndParameters (self)
 checks the model data and parameters to ensure it is setup correctly
 
 controlVector (self)
 returns the control vector pointer.
 
 printStatus (self)
 prints the status of the optimisation
 
 getName (self)
 returns the model name
 
 loadModel (self, modeldata)
 loads the model and stores the pointer in the interface
 
 modelStatus (self)
 returns the model status
 
 solutionStatus (self)
 return the solution status
 
 iterations (self)
 returns the number of iterations
 
 objectiveValue (self)
 returns the objective value
 
 getVariableValues (self)
 returns the variable values
 
 getVariableMarginals (self)
 returns the variable marginals
 
 getVariableBasisStatus (self)
 returns the variable basis status
 
 getVariableStatus (self)
 returns the variable status
 
 getConstraintValues (self)
 returns the constraint values
 
 getConstraintMarginals (self)
 returns the constraint marginals
 
 getConstraintBasisStatus (self)
 returns the constraint basis status
 
 getConstraintStatus (self)
 returns the constraint status
 
 setMessageHandler (self, msghandler)
 sets the message handler to the user supplied handler.
 
 sendMessage (self, msg)
 sends a message to the message handler
 
 setVerbosityLevel (self, verblevel)
 sets the verbosity level for messaging
 
 debugFV (self, debugfv)
 turn Debugging of FDEval on and off.
 
 squareModel (self, square)
 square models.
 
 setLicense (self, licint1, licint2, licint3, licstring)
 define the License Information.
 
 setItLim (self, itlim)
 define the Iteration Limit.
 
 setErrLim (self, errlim)
 define the Error Limit.
 
 fVincLin (self, fvinclin)
 include the linear terms in function evaluations.
 
 fVforAll (self, fvforall)
 call the FDEval for all constraints, including linear constraints.
 
 setMaxSup (self, maxsup)
 limit on superbasics.
 
 allowEmptyRow (self, emptyrow)
 allow empty rows.
 
 allowEmptyCol (self, emptycol)
 allow empty columns.
 
 debug2D (self, debug2d)
 turn debugging of 2nd derivatives on and off.
 
 disCont (self, discont)
 allow discontinuous functions and derivatives.
 
 clearM (self, clearm)
 ClearM.
 
 setResLim (self, reslim)
 define resource limit.
 
 setMaxHeap (self, maxheap)
 define Limit on Heap Memory.
 
 setThreadS (self, threads)
 number of threads allowed internally in CONOPT.
 
 setThreadF (self, threadf)
 number of threads allowed for simultaneous FDEval calls.
 
 setThread2D (self, thread2d)
 number of threads allowed for simultaneous 2DDir calls.
 
 setThreadC (self, threadc)
 check for thread compatibility.
 
 getMaxThreads (self)
 returns the maximum number of threads that can be used by CONOPT.
 
 getMaxHeapUsed (self)
 After a model has been solved this method will return the amount of heap memory used.
 
 getRangeErrors (self)
 returns the range errors that were encountered.
 
synchronized void delete ()
 
 Conopt (String modelName)
 
 Conopt ()
 
int solve ()
 method for starting the solving process of CONOPT.
 
int checkModelAndParameters ()
 
SWIGTYPE_p_coiHandle_t controlVector ()
 
void printStatus ()
 
String getName ()
 
void loadModel (ConoptModelData modeldata)
 
int modelStatus ()
 
int solutionStatus ()
 
int iterations ()
 
double objectiveValue ()
 
double[] getVariableValues ()
 
double[] getVariableMarginals ()
 
int[] getVariableBasisStatus ()
 
int[] getVariableStatus ()
 
double[] getConstraintValues ()
 
double[] getConstraintMarginals ()
 
int[] getConstraintBasisStatus ()
 
int[] getConstraintStatus ()
 
void setMessageHandler (MessageHandler msghandler)
 
int sendMessage (String msg)
 
void setVerbosityLevel (int verblevel)
 
int debugFV (int debugfv)
 turn Debugging of FDEval on and off.
 
int squareModel (int square)
 square models.
 
int setLicense (int licint1, int licint2, int licint3, String licstring)
 define the License Information.
 
int setItLim (int itlim)
 define the Iteration Limit.
 
int setErrLim (int errlim)
 define the Error Limit.
 
int fVincLin (int fvinclin)
 include the linear terms in function evaluations.
 
int fVforAll (int fvforall)
 call the FDEval for all constraints, including linear constraints.
 
int setMaxSup (int maxsup)
 limit on superbasics.
 
int allowEmptyRow (int emptyrow)
 allow empty rows.
 
int allowEmptyCol (int emptycol)
 allow empty columns.
 
int debug2D (int debug2d)
 turn debugging of 2nd derivatives on and off.
 
int disCont (int discont)
 allow discontinuous functions and derivatives.
 
int clearM (int clearm)
 ClearM.
 
int setResLim (double reslim)
 define resource limit.
 
int setMaxHeap (double maxheap)
 define Limit on Heap Memory.
 
int setThreadS (int threads)
 number of threads allowed internally in CONOPT.
 
int setThreadF (int threadf)
 number of threads allowed for simultaneous FDEval calls.
 
int setThread2D (int thread2d)
 number of threads allowed for simultaneous 2DDir calls.
 
int setThreadC (int threadc)
 check for thread compatibility.
 
int getMaxThreads ()
 
double getMaxHeapUsed ()
 
int getRangeErrors ()
 

Static Public Member Functions

 version ()
 returns the version number.
 
static int[] version ()
 

Static Public Attributes

 Infinity = libconoptpy4.Conopt_Infinity
 
static final double Infinity = 1e+20
 

Protected Member Functions

 Conopt (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long getCPtr (Conopt obj)
 
static long swigRelease (Conopt obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

The Conopt class.

The Conopt class

Definition at line 1380 of file conopt.py.

Constructor & Destructor Documentation

◆ __init__()

conopt.Conopt.__init__ ( self,
* args )

Constructor.

Parameters
modelNamethe name for the model.

Definition at line 1392 of file conopt.py.

◆ Conopt() [1/3]

conopt.Conopt.Conopt ( long cPtr,
boolean cMemoryOwn )
inlineprotected

Definition at line 24 of file Conopt.java.

◆ Conopt() [2/3]

conopt.Conopt.Conopt ( String modelName)
inline

Constructor

Parameters
modelNamethe name for the model.

Definition at line 67 of file Conopt.java.

◆ Conopt() [3/3]

conopt.Conopt.Conopt ( )
inline

Constructor

Definition at line 78 of file Conopt.java.

Member Function Documentation

◆ checkModelAndParameters() [1/2]

conopt.Conopt.checkModelAndParameters ( self)

checks the model data and parameters to ensure it is setup correctly

Definition at line 1411 of file conopt.py.

◆ modelStatus() [1/2]

conopt.Conopt.modelStatus ( self)

returns the model status

Definition at line 1458 of file conopt.py.

◆ getCPtr()

static long conopt.Conopt.getCPtr ( Conopt obj)
inlinestaticprotected

Definition at line 29 of file Conopt.java.

◆ swigRelease()

static long conopt.Conopt.swigRelease ( Conopt obj)
inlinestaticprotected

Definition at line 33 of file Conopt.java.

◆ finalize()

void conopt.Conopt.finalize ( )
inlineprotected

Definition at line 46 of file Conopt.java.

◆ delete()

synchronized void conopt.Conopt.delete ( )
inline

Definition at line 50 of file Conopt.java.

◆ checkModelAndParameters() [2/2]

int conopt.Conopt.checkModelAndParameters ( )
inline

checks the model data and parameters to ensure it is setup correctly

Definition at line 97 of file Conopt.java.

◆ modelStatus() [2/2]

int conopt.Conopt.modelStatus ( )
inline

returns the model status

Definition at line 153 of file Conopt.java.

Field Documentation

◆ Infinity [1/2]

conopt.Conopt.Infinity = libconoptpy4.Conopt_Infinity
static

Definition at line 1389 of file conopt.py.

◆ swigCMemOwn

transient boolean conopt.Conopt.swigCMemOwn
protected

Definition at line 22 of file Conopt.java.

◆ Infinity [2/2]

final double conopt.Conopt.Infinity = 1e+20
static

CONOPT value for infinity

Definition at line 571 of file Conopt.java.

Property Documentation

◆ thisown

conopt.Conopt.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 1387 of file conopt.py.


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