Package com.opttek.optquest

Class COptQuestFourierCorrectionMatrixVariable

java.lang.Object

com.opttek.optquest.COptQuestVariable

com.opttek.optquest.COptQuestUserControlledVariable

com.opttek.optquest.COptQuestManifoldVariable

com.opttek.optquest.COptQuestFourierCorrectionMatrixVariable

public class COptQuestFourierCorrectionMatrixVariable
extends COptQuestManifoldVariable

A Fourier correction matrix variable. Its value is a baseline matrix, initial, plus a correction that is a sum of the lowest-frequency cosine terms: freqRows terms down the columns and freqCols terms along the rows. Use a Fourier correction matrix variable to keep a known table and change it smoothly.

The terms are products of a cosine down the columns and a cosine along the rows, like the terms of the vector type. With one term down the columns, every row of the correction is the same. With one term along the rows, every column of the correction is the same.

In every solution that the engine generates, every entry is from min to max. The engine first moves each entry of initial into [min, max].

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.AddFourierCorrectionMatrixVariable 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.AddFourierCorrectionMatrixVariable(String, double[][], int, int, double, double)

Constructor Summary

Constructors

Constructor	Description
COptQuestFourierCorrectionMatrixVariable(String name, double[][] initial, int freqRows, int freqCols, double min, double max)	Creates a Fourier correction matrix variable.

Method Summary

Modifier and Type	Method	Description
List<COptQuestVariable>	getInputVariables()	Returns an empty list, because a Fourier correction matrix variable has no ordinary input variables.
List<COptQuestUserControlledVariable>	getOutputVariables()	Returns an empty list, because a Fourier 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

COptQuestFourierCorrectionMatrixVariable

public COptQuestFourierCorrectionMatrixVariable(String name,
 double[][] initial,
 int freqRows,
 int freqCols,
 double min,
 double max)
                                         throws COptQuestException

Creates a Fourier correction matrix variable.

Parameters:

name - base name of the variable

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

freqRows - number of cosine terms down each column; the rows are more alike with fewer terms. A value less than 1 is used as 1, and a value greater than the number of rows is used as that number.

freqCols - number of cosine terms along each row; the columns are more alike with fewer terms. A value less than 1 is used as 1, and a value greater than the number of columns is used as that number.

min - lower bound of every entry

max - upper bound of every entry

Throws:

COptQuestException - if an error occurs while the variable is created

Method Details

getInputVariables

public List<COptQuestVariable> getInputVariables()

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

The values of a Fourier 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 Fourier correction matrix variable has no output variables.

The values of a Fourier 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