Initializing help system before first use

VariableBuilder.VariableArray2Builder

  • java.lang.Object
    • com.dashoptimization.VariableBuilder.VariableArray2Builder
  • Enclosing class:
    VariableBuilder 
    public static final class VariableBuilder.VariableArray2Builder
extends java.lang.Object
    Build a 2 dimensional array of variables.
    Since:
    43.00

    • Constructor Detail

      • VariableArray2Builder

        public VariableArray2Builder​(int dim1,
                             int dim2,
                             XpressProblem prob)
        Create a builder that will create a 2-dimensional array of variables with the specified dimensions.
        Parameters:
        dim1 - Dimension 1.
        dim2 - Dimension 2.
        prob - The problem for which to create variables.
        Since:
        43.00

    • Method Detail

      • withLB

        public VariableBuilder.VariableArray2Builder withLB​(IntFunction2<java.lang.Double> lb)
        Set a lower bound that depends on the index.
        Parameters:
        lb - The lower bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLB

        public VariableBuilder.VariableArray2Builder withLB​(double lb)
        Set a constant lower bound for all variables.
        Parameters:
        lb - The lower bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLB

        public VariableBuilder.VariableArray2Builder withLB​(double[][] lb)
        Set a lower bound that is given by an array. The dimension(s) of the passed array must match the dimension(s) that were passed to the constructor.
        Parameters:
        lb - Lower bounds for the individual variables.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withUB

        public VariableBuilder.VariableArray2Builder withUB​(IntFunction2<java.lang.Double> ub)
        Set a upper bound that depends on the index.
        Parameters:
        ub - The upper bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withUB

        public VariableBuilder.VariableArray2Builder withUB​(double ub)
        Set a constant upper bound for all variables.
        Parameters:
        ub - The upper bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withUB

        public VariableBuilder.VariableArray2Builder withUB​(double[][] ub)
        Set an upper bound that is given by an array. The dimension(s) of the passed array must match the dimension(s) that were passed to the constructor.
        Parameters:
        ub - Upper bounds for the individual variables.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLimit

        public VariableBuilder.VariableArray2Builder withLimit​(IntFunction2<java.lang.Double> limit)
        Set a limit depends on the index. A limit specifies the bounds for semi-continuous/integer variables and the limit for partial integer variables. It does not apply to variables of other types.
        Parameters:
        limit - The limit for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLimit

        public VariableBuilder.VariableArray2Builder withLimit​(double limit)
        Set a constant limit for all variables. A limit specifies the bounds for semi-continuous/integer variables and the limit for partial integer variables. It does not apply to variables of other types.
        Parameters:
        limit - The limit for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLimit

        public VariableBuilder.VariableArray2Builder withLimit​(double[][] limit)
        Set a limit that is given by an array. The dimension(s) of the passed array must match the dimension(s) that were passed to the constructor.
        Parameters:
        limit - Limits for the individual variables.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withName

        public VariableBuilder.VariableArray2Builder withName​(IntFunction2<java.lang.String> name)
        Set a name that depends on the index.
        Parameters:
        name - The name for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withName

        public VariableBuilder.VariableArray2Builder withName​(java.lang.String name)
        Set a constant name for all variables.
        Parameters:
        name - The name for all variables created by this builder. This must be null or a format string that will be invoked with the index as argument.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withName

        public VariableBuilder.VariableArray2Builder withName​(java.lang.String[][] name)
        Set a name bound that is given by an array. The dimension(s) of the passed array must match the dimension(s) that were passed to the constructor.
        Parameters:
        name - Names for the individual variables.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withType

        public VariableBuilder.VariableArray2Builder withType​(ColumnType type)
        Set the type for all variables.
        Parameters:
        type - The type for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withType

        public VariableBuilder.VariableArray2Builder withType​(ColumnType[][] type)
        Set a type that is given by an array. The dimension(s) of the passed array must match the dimension(s) that were passed to the constructor.
        Parameters:
        type - Types for the individual variables.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • toArray

        public Variable[][] toArray()
        Create variables as specified by this builder.

        Used in these examples:

        • Polygon
        • PolygonMap
        • PolygonMapDelta
        • PolygonMultiMap
        • PolygonMultiMapDelta
        • PolygonVecMap
        • PolygonVecMapDelta
        • TSP
        Since:
        43.00

      • toArray

        public <I> I toArray​(java.util.function.Supplier<I> makeResult,
                     Action4<I,​java.lang.Integer,​java.lang.Integer,​Variable> addResult)
        Create variables as specified by this builder.

        Used in these examples:

        • Polygon
        • PolygonMap
        • PolygonMapDelta
        • PolygonMultiMap
        • PolygonMultiMapDelta
        • PolygonVecMap
        • PolygonVecMapDelta
        • TSP
        Type Parameters:
        I - Type of return value.
        Parameters:
        makeResult - A function to create the (empty) return value.
        addResult - A function to add a value to the result.
        Since:
        43.00
Parent Topic Class Summary

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.