CONOPT
Loading...
Searching...
No Matches
pyconopt.Conopt Class Reference

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.
 

Static Public Member Functions

 version ()
 returns the version number.
 

Properties

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

Detailed Description

The Conopt class.

Definition at line 1416 of file pyconopt.py.

Constructor & Destructor Documentation

◆ __init__()

pyconopt.Conopt.__init__ ( self,
* args )

Constructor.

Parameters
modelNamethe name for the model.

Definition at line 1426 of file pyconopt.py.

Member Function Documentation

◆ checkModelAndParameters()

pyconopt.Conopt.checkModelAndParameters ( self)

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

Definition at line 1445 of file pyconopt.py.

◆ modelStatus()

pyconopt.Conopt.modelStatus ( self)

returns the model status

Definition at line 1492 of file pyconopt.py.

Property Documentation

◆ thisown

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

Definition at line 1423 of file pyconopt.py.


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