Initializing help system before first use

VariableBuilder.VariableMap4Builder

  • java.lang.Object
    • com.dashoptimization.VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4>
  • Enclosing class:
    VariableBuilder 
    public static class VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4>
extends java.lang.Object
    Build a 4-dimensional map of variables.
    Since:
    43.00

    • Constructor Detail

      • VariableMap4Builder

        @Deprecated
public VariableMap4Builder​(java.util.Collection<K1> coll1,
                           java.util.Collection<K2> coll2,
                           java.util.Collection<K3> coll3,
                           java.util.Collection<K4> coll4,
                           XpressProblem prob)
        Deprecated.
        since 44.00, use the equivalent overload that takes Iterable arguments
        Create a builder that will create a 4-dimensional map of variables from the specified data.
        Parameters:
        coll1 - Data for the builder.
        coll2 - Data for the builder.
        coll3 - Data for the builder.
        coll4 - Data for the builder.
        prob - The problem for which to create variables.
        Since:
        43.00

      • VariableMap4Builder

        public VariableMap4Builder​(java.lang.Iterable<K1> iterable1,
                           java.lang.Iterable<K2> iterable2,
                           java.lang.Iterable<K3> iterable3,
                           java.lang.Iterable<K4> iterable4,
                           XpressProblem prob)
        Create a builder that will create a 4-dimensional map of variables from the specified data.
        Parameters:
        iterable1 - Data for the builder.
        iterable2 - Data for the builder.
        iterable3 - Data for the builder.
        iterable4 - Data for the builder.
        prob - The problem for which to create variables.
        Since:
        44.00

      • VariableMap4Builder

        @Deprecated
public VariableMap4Builder​(K1[] arr1,
                           K2[] arr2,
                           K3[] arr3,
                           K4[] arr4,
                           XpressProblem prob)
        Deprecated.
        since 44.00, use the equivalent overload that takes Iterable arguments
        Create a builder that will create a 4-dimensional map of variables from the specified arrays.
        Parameters:
        arr1 - Data for the builder.
        arr2 - Data for the builder.
        arr3 - Data for the builder.
        arr4 - Data for the builder.
        prob - The problem for which to create variables.
        Since:
        43.00

    • Method Detail

      • withLB

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withLB​(Function4<K1,​K2,​K3,​K4,​java.lang.Double> newLb)
        Set a lower bound that depends on the index.
        Parameters:
        newLb - The lower bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLB

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withLB​(double newLb)
        Set a constant lower bound for all variables.
        Parameters:
        newLb - The lower bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withUB

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withUB​(Function4<K1,​K2,​K3,​K4,​java.lang.Double> newUb)
        Set a upper bound that depends on the index.
        Parameters:
        newUb - The upper bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withUB

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withUB​(double newUb)
        Set a constant upper bound for all variables.
        Parameters:
        newUb - The upper bound for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLimit

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withLimit​(Function4<K1,​K2,​K3,​K4,​java.lang.Double> newLimit)
        Set a limit that 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:
        newLimit - The limit for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withLimit

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withLimit​(double newLimit)
        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:
        newLimit - The limit for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withName

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withName​(Function4<K1,​K2,​K3,​K4,​java.lang.String> newName)
        Set a name that depends on the index.
        Parameters:
        newName - The name for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • withName

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withName​(java.lang.String newName)
        Set a constant name for all variables.
        Parameters:
        newName - 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

      • withType

        public VariableBuilder.VariableMap4Builder<K1,​K2,​K3,​K4> withType​(ColumnType newType)
        Set a constant type for all variables.
        Parameters:
        newType - The type for all variables created by this builder.
        Returns:
        Always returns this instance.
        Since:
        43.00

      • toMap

        public HashMap4<K1,​K2,​K3,​K4,​Variable> toMap()
        Create the variables specified by this builder.
        Returns:
        The created variables.
        Since:
        43.00

      • toMap

        public <I> I toMap​(java.util.function.Supplier<I> makeResult,
                   Action6<I,​K1,​K2,​K3,​K4,​Variable> addResult)
        Create the variables specified by this builder.
        Type Parameters:
        I - Type of result
        Parameters:
        makeResult - Function to create an (empty) result.
        addResult - Function to add an element to the result.
        Returns:
        The created variables.
        Since:
        43.00
Parent Topic Class Summary

© 2001-2025 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.