CONOPT
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
jconopt.Variable Class Reference
The public API of CONOPT » Java API » ModelData Class » Querying the model

Public Member Functions

synchronized void delete ()
 
 Variable (int idx, double low, double up, double cur, int varstat)
 
 Variable (int idx, double low, double up, double cur)
 
 Variable (int idx, double low, double up)
 
void addNonzero (int conindex, double value, int nlflag)
 
void sortNonzeros ()
 
void setIndex (int value)
 
int getIndex ()
 
void setLower (double value)
 
double getLower ()
 
void setUpper (double value)
 
double getUpper ()
 
void setCurr (double value)
 
double getCurr ()
 
void setVarstatus (int value)
 
int getVarstatus ()
 
void setConsindex_ (SWIGTYPE_p_std__vectorT_int_t value)
 
SWIGTYPE_p_std__vectorT_int_t getConsindex_ ()
 
void setValue_ (SWIGTYPE_p_std__vectorT_double_t value)
 
SWIGTYPE_p_std__vectorT_double_t getValue_ ()
 
void setNlflag_ (SWIGTYPE_p_std__vectorT_int_t value)
 
SWIGTYPE_p_std__vectorT_int_t getNlflag_ ()
 
void setSortorder_ (SWIGTYPE_p_std__vectorT_int_t value)
 
SWIGTYPE_p_std__vectorT_int_t getSortorder_ ()
 

Protected Member Functions

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

Static Protected Member Functions

static long getCPtr (Variable obj)
 
static long swigRelease (Variable obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

the variable data

This struct is used internally for supplying the variable data to CONOPT. The user is able to query this data from the ConoptModelData object. However, the user is not able to change the data after the variable has been added to CONOPT.

Definition at line 25 of file Variable.java.

Constructor & Destructor Documentation

◆ Variable() [1/4]

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

Definition at line 29 of file Variable.java.

◆ Variable() [2/4]

jconopt.Variable.Variable ( int idx,
double low,
double up,
double cur,
int varstat )
inline

Definition at line 65 of file Variable.java.

◆ Variable() [3/4]

jconopt.Variable.Variable ( int idx,
double low,
double up,
double cur )
inline

Definition at line 69 of file Variable.java.

◆ Variable() [4/4]

jconopt.Variable.Variable ( int idx,
double low,
double up )
inline

Definition at line 73 of file Variable.java.

Member Function Documentation

◆ getCPtr()

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

Definition at line 34 of file Variable.java.

◆ swigRelease()

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

Definition at line 38 of file Variable.java.

◆ finalize()

void jconopt.Variable.finalize ( )
inlineprotected

Definition at line 51 of file Variable.java.

◆ delete()

synchronized void jconopt.Variable.delete ( )
inline

Definition at line 55 of file Variable.java.

◆ addNonzero()

void jconopt.Variable.addNonzero ( int conindex,
double value,
int nlflag )
inline

adds a non-zero to the variable data

Note: this is used internally.

Definition at line 82 of file Variable.java.

◆ sortNonzeros()

void jconopt.Variable.sortNonzeros ( )
inline

sorts the non-zeros by constraint index.

Note: this is used internally.

Definition at line 91 of file Variable.java.

◆ setIndex()

void jconopt.Variable.setIndex ( int value)
inline

the index of the variable in the problem

Definition at line 98 of file Variable.java.

◆ getIndex()

int jconopt.Variable.getIndex ( )
inline

the index of the variable in the problem

Definition at line 105 of file Variable.java.

◆ setLower()

void jconopt.Variable.setLower ( double value)
inline

the lower bound of the variables

Definition at line 112 of file Variable.java.

◆ getLower()

double jconopt.Variable.getLower ( )
inline

the lower bound of the variables

Definition at line 119 of file Variable.java.

◆ setUpper()

void jconopt.Variable.setUpper ( double value)
inline

the upper bounds of the variables

Definition at line 126 of file Variable.java.

◆ getUpper()

double jconopt.Variable.getUpper ( )
inline

the upper bounds of the variables

Definition at line 133 of file Variable.java.

◆ setCurr()

void jconopt.Variable.setCurr ( double value)
inline

the initial values of the variables. This is 0 by default.

Definition at line 140 of file Variable.java.

◆ getCurr()

double jconopt.Variable.getCurr ( )
inline

the initial values of the variables. This is 0 by default.

Definition at line 147 of file Variable.java.

◆ setVarstatus()

void jconopt.Variable.setVarstatus ( int value)
inline

the initial status of the variables. The depends on the COIDEF_IniStat setting.

Definition at line 154 of file Variable.java.

◆ getVarstatus()

int jconopt.Variable.getVarstatus ( )
inline

the initial status of the variables. The depends on the COIDEF_IniStat setting.

Definition at line 161 of file Variable.java.

◆ setConsindex_()

void jconopt.Variable.setConsindex_ ( SWIGTYPE_p_std__vectorT_int_t value)
inline

the index of the constraints

Definition at line 168 of file Variable.java.

◆ getConsindex_()

SWIGTYPE_p_std__vectorT_int_t jconopt.Variable.getConsindex_ ( )
inline

the index of the constraints

Definition at line 175 of file Variable.java.

◆ setValue_()

void jconopt.Variable.setValue_ ( SWIGTYPE_p_std__vectorT_double_t value)
inline

the non-zero for linear terms, for non-linear terms this is ignored

Definition at line 183 of file Variable.java.

◆ getValue_()

SWIGTYPE_p_std__vectorT_double_t jconopt.Variable.getValue_ ( )
inline

the non-zero for linear terms, for non-linear terms this is ignored

Definition at line 190 of file Variable.java.

◆ setNlflag_()

void jconopt.Variable.setNlflag_ ( SWIGTYPE_p_std__vectorT_int_t value)
inline

indicator whether the non-zero is part of a non-linear term

Definition at line 198 of file Variable.java.

◆ getNlflag_()

SWIGTYPE_p_std__vectorT_int_t jconopt.Variable.getNlflag_ ( )
inline

indicator whether the non-zero is part of a non-linear term

Definition at line 205 of file Variable.java.

◆ setSortorder_()

void jconopt.Variable.setSortorder_ ( SWIGTYPE_p_std__vectorT_int_t value)
inline

a vector to support the sorting of the non-zeros

Definition at line 213 of file Variable.java.

◆ getSortorder_()

SWIGTYPE_p_std__vectorT_int_t jconopt.Variable.getSortorder_ ( )
inline

a vector to support the sorting of the non-zeros

Definition at line 220 of file Variable.java.

Field Documentation

◆ swigCMemOwn

transient boolean jconopt.Variable.swigCMemOwn
protected

Definition at line 27 of file Variable.java.

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