Package com.opttek.optquest

Class COptQuestLowRankCorrectionMatrixVariable

java.lang.Object

com.opttek.optquest.COptQuestVariable

com.opttek.optquest.COptQuestUserControlledVariable

com.opttek.optquest.COptQuestManifoldVariable

com.opttek.optquest.COptQuestLowRankCorrectionMatrixVariable

public class COptQuestLowRankCorrectionMatrixVariable
extends COptQuestManifoldVariable

A low-rank correction matrix variable. Its value is a baseline matrix, initial, plus a correction of low rank. Use a low-rank correction matrix variable to keep a known table and change it with a few row and column patterns.

In every solution that the engine generates, every entry is from min to max, and the matrix is initial plus a correction of rank at most rank. The engine first moves each entry of initial into [min, max].

The value of rank is the number of row patterns that the engine can combine in the correction. With rank 1, each row of the correction is one row pattern, multiplied by an amount that can differ from row to row. With each extra unit of rank, the engine can combine one more row pattern. With rank 0, the value is initial with no correction.

Variable names: <name>@<row>,<col> for each entry, 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].

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

Constructor Summary

Constructors

Constructor	Description
COptQuestLowRankCorrectionMatrixVariable(String name, double[][] initial, int rank, double min, double max)	Creates a low-rank correction matrix variable.

Method Summary

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

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

COptQuestLowRankCorrectionMatrixVariable

public COptQuestLowRankCorrectionMatrixVariable(String name,
 double[][] initial,
 int rank,
 double min,
 double max)
                                         throws COptQuestException

Creates a low-rank correction matrix variable.

Parameters:

name - base name of the variable

initial - the baseline matrix; the variable has the same number of rows and columns

rank - largest rank of the correction. A value greater than the number of rows or columns is reduced to it. With a value of 0 or less, the value of the variable is initial with no correction.

min - lower bound of every entry

max - upper bound of every entry

Throws:

COptQuestException - if min or max is NaN, or if min is greater than max

Method Details

getInputVariables

public List<COptQuestVariable> getInputVariables()

Returns an empty list, because a low-rank correction matrix variable has no ordinary input variables.

The values of a low-rank correction matrix variable are in the list that getProjectedInputVariables() returns. That list has one variable <name>@<row>,<col> for each entry.

Returns:

an empty list

getOutputVariables

public List<COptQuestUserControlledVariable> getOutputVariables()

Returns an empty list, because a low-rank correction matrix variable has no output variables.

The values of a low-rank correction matrix variable are in the list that getProjectedInputVariables() returns. That list has one variable <name>@<row>,<col> for each entry.

Returns:

an empty list

getProjectedInputVariables

public List<COptQuestUserControlledVariable> getProjectedInputVariables()

Description copied from class: COptQuestManifoldVariable

Returns the decision values of this manifold variable that are not ordinary decision variables.

For example, an angle variable returns angle@theta, and a mixture variable returns one mix@<component> name for each component. In every solution that the engine generates, and in every suggested solution, these values are inside the set of the variable. Your evaluator reads them as inputs: OptQuestSolution.GetInputNames() returns them.

A constraint that uses one of these names is checked after the evaluation, like a constraint on an output. Your evaluator can receive values that break the constraint, and the solution is then infeasible.

Specified by:

getProjectedInputVariables in class COptQuestManifoldVariable

Returns:

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