Package com.opttek.optquest

Class COptQuestDiscreteNDVariable

java.lang.Object

com.opttek.optquest.COptQuestVariable

com.opttek.optquest.COptQuestUserControlledVariable

com.opttek.optquest.COptQuestManifoldVariable

com.opttek.optquest.COptQuestDiscreteNDVariable

public class COptQuestDiscreteNDVariable
extends COptQuestManifoldVariable

A discrete N-dimensional variable: an array of discrete variables with the shape dims. The elements are ordinary input variables.

Variable names: <name>@<i1>,<i2>,... for each element, with one 1-based index for each dimension. The last index changes fastest. With two or more dimensions, each name contains a comma, so write it in brackets in an expression: [<name>@1,2,3].

Each element takes the values min, min + step, min + 2 × step, and so on. The largest value is the one nearest to max, so it can differ from max when max - min is not a whole multiple of step.

In most programs, you add this variable with OptQuestModel.AddDiscreteNDVariable 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.AddDiscreteNDVariable(String, int[], double, double, double)

Constructor Summary

Constructors

Constructor	Description
COptQuestDiscreteNDVariable(String name, int[] dims, double min, double max, double step)	Creates a discrete N-dimensional 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 discrete N-dimensional variable has no output variables.
List<COptQuestUserControlledVariable>	getProjectedInputVariables()	Returns an empty list, because the values of a discrete N-dimensional 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

COptQuestDiscreteNDVariable

public COptQuestDiscreteNDVariable(String name,
 int[] dims,
 double min,
 double max,
 double step)
                            throws COptQuestException

Creates a discrete N-dimensional variable.

Parameters:

name - base name of the variable

dims - size of each dimension; there must be at least one dimension, and each size must be at least 1

min - lower bound of each element

max - upper bound of each element

step - step between values; must be greater than 0

Throws:

COptQuestException - if dims is null or empty, or if a size is less than 1

Method Details

getProjectedInputVariables

public List<COptQuestUserControlledVariable> getProjectedInputVariables()

Returns an empty list, because the values of a discrete N-dimensional variable are ordinary inputs.

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

Returns:

an empty list

getOutputVariables

public List<COptQuestUserControlledVariable> getOutputVariables()

Returns an empty list, because a discrete N-dimensional variable has no output variables.

The values of a discrete N-dimensional variable are ordinary inputs, so they are in the list that getInputVariables() returns. That list has one variable <name>@<i1>,<i2>,... 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