Package com.opttek.optquest

Class COptQuestBinaryVectorVariable

java.lang.Object
com.opttek.optquest.COptQuestVariable
com.opttek.optquest.COptQuestUserControlledVariable
com.opttek.optquest.COptQuestManifoldVariable
com.opttek.optquest.COptQuestBinaryVectorVariable
public final class COptQuestBinaryVectorVariable extends COptQuestManifoldVariable
A binary vector variable: k binary variables. The elements are ordinary input variables.

Variable names: <name>@1 to <name>@k, one for each element.

The value of each element is 0 or 1.

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

  • Constructor Details

    • COptQuestBinaryVectorVariable

      public COptQuestBinaryVectorVariable(String name, int k) throws COptQuestException
      Creates a binary vector variable.
      Parameters:
      name - base name of the variable
      k - number of elements; must be at least 1
      Throws:
      COptQuestException - if k is less than 1

  • Method Details

    • getProjectedInputVariables

      public List<COptQuestUserControlledVariable> getProjectedInputVariables()
      Returns an empty list, because the values of a binary vector variable are ordinary inputs.

      The values are in the list that getInputVariables() returns. That list has the variables <name>@1 to <name>@k, one for each element.

      Returns:
      an empty list

    • getOutputVariables

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

      The values of a binary vector variable are ordinary inputs, so they are in the list that getInputVariables() returns. That list has the variables <name>@1 to <name>@k, one 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