Package com.opttek.optquest

Class COptQuestSplineCorrectionVectorVariable

java.lang.Object
com.opttek.optquest.COptQuestVariable
com.opttek.optquest.COptQuestUserControlledVariable
com.opttek.optquest.COptQuestManifoldVariable
com.opttek.optquest.COptQuestSplineCorrectionVectorVariable
public class COptQuestSplineCorrectionVectorVariable extends COptQuestManifoldVariable
A spline correction vector variable. Its value is a baseline vector, initial, plus a correction on a smooth curve through numKnots knots. Use a spline correction vector variable to keep a known profile and change it smoothly.

The curve is a centripetal Catmull-Rom spline. It is smooth, and it passes through its knots. The knots are at evenly spaced elements, with the first and last knots at the two ends.

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

Variable names: <name>@1 to <name>@length, one for each element. The number of elements is the length of initial.

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

  • Constructor Details

    • COptQuestSplineCorrectionVectorVariable

      public COptQuestSplineCorrectionVectorVariable(String name, double[] initial, int numKnots, double min, double max) throws COptQuestException
      Creates a spline correction vector variable.
      Parameters:
      name - base name of the variable
      initial - the baseline vector; the variable has the same number of elements
      numKnots - number of knots; the curve is smoother with fewer knots. A value less than 2 is used as 2, and a value greater than the number of elements is used as that number.
      min - lower bound of every element
      max - upper bound of every element
      Throws:
      COptQuestException - if an error occurs while the variable is created

  • Method Details

    • getInputVariables

      public List<COptQuestVariable> getInputVariables()
      Returns an empty list, because a spline correction vector variable has no ordinary input variables.

      The values of a spline correction vector variable are in the list that getProjectedInputVariables() returns. That list has the variables <name>@1 to <name>@length, one for each element.

      Returns:
      an empty list

    • getOutputVariables

      public List<COptQuestUserControlledVariable> getOutputVariables()
      Returns an empty list, because a spline correction vector variable has no output variables.

      The values of a spline correction vector variable are in the list that getProjectedInputVariables() returns. That list has the variables <name>@1 to <name>@length, one for each element.

      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