Package com.opttek.optquest

Class COptQuestMatrixVariable

java.lang.Object

com.opttek.optquest.COptQuestVariable

com.opttek.optquest.COptQuestUserControlledVariable

com.opttek.optquest.COptQuestManifoldVariable

com.opttek.optquest.COptQuestMatrixVariable

public class COptQuestMatrixVariable
extends COptQuestManifoldVariable

A matrix variable: an m by n matrix of continuous variables. The elements are ordinary input variables.

Variable names: <name>@<row>,<col> for each element, with 1-based row and column numbers, row by row. Each name contains a comma, so write it in brackets in an expression: [<name>@1,2].

The value of each element is a continuous value from min to max.

In most programs, you add this variable with OptQuestModel.AddMatrixVariable and read its values with OptQuestSolution.GetValue(String) and the generated names. Construct this class only when you add the variable with COptQuestOptimization.AddVariable(COptQuestVariable).

See Also:

• OptQuestModel.AddMatrixVariable(String, int, int, double, double)

Constructor Summary

Constructors

Constructor	Description
COptQuestMatrixVariable(String name, int m, int n, double min, double max)	Creates a matrix variable.

Method Summary

Modifier and Type	Method	Description
List<COptQuestVariable>	getInputVariables()	Returns the ordinary decision variables of this manifold variable.
List<COptQuestUserControlledVariable>	getOutputVariables()	Returns an empty list, because a matrix variable has no output variables.
List<COptQuestUserControlledVariable>	getProjectedInputVariables()	Returns an empty list, because the values of a matrix variable are ordinary inputs.

Methods inherited from class com.opttek.optquest.COptQuestManifoldVariable

getConstraints

Methods inherited from class com.opttek.optquest.COptQuestUserControlledVariable

GetReplicationStatistic, GetReplicationStatisticValue, SetExclusiveRange, SetLowerBound, SetReplicationStatistic, SetUpperBound

Methods inherited from class com.opttek.optquest.COptQuestVariable

equals, GetDOELowerBound, GetDOEUpperBound, GetExclusiveLowerBoundAt, GetExclusiveUpperBoundAt, getID, GetLowerBound, GetName, GetNumberOfExclusiveRanges, GetStepSize, GetSuggestedValue, GetUpperBound, getVarRange, hashCode, isZeroOne, SetName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

COptQuestMatrixVariable

public COptQuestMatrixVariable(String name,
 int m,
 int n,
 double min,
 double max)
                        throws COptQuestException

Creates a matrix variable.

Parameters:

name - base name of the variable

m - number of rows; must be at least 1

n - number of columns; must be at least 1

min - lower bound of each element

max - upper bound of each element

Throws:

COptQuestException - if m or n is less than 1

Method Details

getProjectedInputVariables

public List<COptQuestUserControlledVariable> getProjectedInputVariables()

Returns an empty list, because the values of a matrix variable are ordinary inputs.

The values are in the list that getInputVariables() returns. That list has one variable <name>@<row>,<col> for each element.

Returns:

an empty list

getOutputVariables

public List<COptQuestUserControlledVariable> getOutputVariables()

Returns an empty list, because a matrix variable has no output variables.

The values of a matrix variable are ordinary inputs, so they are in the list that getInputVariables() returns. That list has one variable <name>@<row>,<col> for each element.

Returns:

an empty list

getInputVariables

public List<COptQuestVariable> getInputVariables()

Description copied from class: COptQuestManifoldVariable

Returns the ordinary decision variables of this manifold variable.

The engine chooses these values directly. Your evaluator reads them as inputs. The item selection and budgeted selection types use this list, and so do the vector, matrix and N-dimensional types of continuous, integer, discrete and binary variables. For every other type, the list is empty.

Specified by:

getInputVariables in class COptQuestManifoldVariable

Returns:

fixed-size or immutable list of input variables; never null