Initializing help system before first use

# VariableBuilder.Map5Builder

- java.lang.Object
- - com.dashoptimization.VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>

- Enclosing class:
    VariableBuilder

      public static class VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>
      extends java.lang.Object

  Build a 5-dimensional map of columns or variables.
  Since:
    43.00

- - ### Constructor Summary

    Constructor | Description
    --- | ---
    `Map5Builder​(java.lang.Iterable<K1> iterable1, java.lang.Iterable<K2> iterable2, java.lang.Iterable<K3> iterable3, java.lang.Iterable<K4> iterable4, java.lang.Iterable<K5> iterable5)` | Create a builder that will create a 5-dimensional map of columns or variables from the specified data.
    `Map5Builder​(K1[] arr1, K2[] arr2, K3[] arr3, K4[] arr4, K5[] arr5)` | Deprecated. since 44.00, use the equivalent overload that takes Iterable arguments

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `HashMap5<K1,​K2,​K3,​K4,​K5,​Variable>` | `build​(XpressProblem prob)` | Create variables as specified by this builder.
    `HashMap5<K1,​K2,​K3,​K4,​K5,​java.lang.Integer>` | `build​(XPRSprob prob)` | Create columns as specified by this builder.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withFilter​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Boolean> newFilter)` | Set a filter that selects elements.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withLB​(double newLb)` | Set a constant lower bound for all columns or variables.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withLB​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Double> newLb)` | Set a lower bound that depends on the index.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withLimit​(double newLimit)` | Set a constant limit for all columns or variables.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withLimit​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Double> newLimit)` | Set a limit that depends on the index.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withName​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.String> newName)` | Set a name that depends on the index.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withName​(java.lang.String newName)` | Set a constant name for all columns or variables.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withType​(ColumnType newType)` | Set a constant type for all columns or variables.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withType​(Function5<K1,​K2,​K3,​K4,​K5,​ColumnType> newType)` | Set a type that depends on the index.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withUB​(double newUb)` | Set a constant upper bound for all columns or variables.
    `VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5>` | `withUB​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Double> newUb)` | Set a upper bound that depends on the index.

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Map5Builder

          public Map5Builder​(java.lang.Iterable<K1> iterable1,
                             java.lang.Iterable<K2> iterable2,
                             java.lang.Iterable<K3> iterable3,
                             java.lang.Iterable<K4> iterable4,
                             java.lang.Iterable<K5> iterable5)

      Create a builder that will create a 5-dimensional map of columns or 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.
        `iterable5` - Data for the builder.
      Since:
        44.00

    - #### Map5Builder

          @Deprecated
          public Map5Builder​(K1[] arr1,
                             K2[] arr2,
                             K3[] arr3,
                             K4[] arr4,
                             K5[] arr5)

      Deprecated.
      since 44.00, use the equivalent overload that takes Iterable arguments
      Create a builder that will create a 5-dimensional map of columns or 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.
        `arr5` - Data for the builder.
      Since:
        43.00

  - ### Method Detail

    - #### withLB

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withLB​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Double> newLb)

      Set a lower bound that depends on the index.

      Examples using `withLB`:

      - CuttingStock.java
      - FacilityLocationArray.java
      - FacilityLocationCollection.java
      - Glidert.java
      - Polygon.java
      - PolygonMap.java
      - PolygonMapDelta.java
      - PolygonMultiMap.java
      - PolygonMultiMapDelta.java
      - PolygonVecMap.java
      - PolygonVecMapDelta.java
      Parameters:
        `newLb` - The lower bound for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withLB

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withLB​(double newLb)

      Set a constant lower bound for all columns or variables.

      Examples using `withLB`:

      - CuttingStock.java
      - FacilityLocationArray.java
      - FacilityLocationCollection.java
      - Glidert.java
      - Polygon.java
      - PolygonMap.java
      - PolygonMapDelta.java
      - PolygonMultiMap.java
      - PolygonMultiMapDelta.java
      - PolygonVecMap.java
      - PolygonVecMapDelta.java
      Parameters:
        `newLb` - The lower bound for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withUB

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withUB​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Double> newUb)

      Set a upper bound that depends on the index.

      Examples using `withUB`:

      - CuttingStock.java
      - FacilityLocationArray.java
      - FolioMip2.java
      - MultipleProblems.java
      - Polygon.java
      - PolygonMap.java
      - PolygonMapDelta.java
      - PolygonMultiMap.java
      - PolygonMultiMapDelta.java
      - PolygonObjects.java
      - PolygonVecMap.java
      - PolygonVecMapDelta.java
      - ProductionPlanning_Index.java
      - PurchasePWL.java
      - PurchaseSOS2.java
      - TravelingSalesPerson.java
      Parameters:
        `newUb` - The upper bound for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withUB

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withUB​(double newUb)

      Set a constant upper bound for all columns or variables.

      Examples using `withUB`:

      - CuttingStock.java
      - FacilityLocationArray.java
      - FolioMip2.java
      - MultipleProblems.java
      - Polygon.java
      - PolygonMap.java
      - PolygonMapDelta.java
      - PolygonMultiMap.java
      - PolygonMultiMapDelta.java
      - PolygonObjects.java
      - PolygonVecMap.java
      - PolygonVecMapDelta.java
      - ProductionPlanning_Index.java
      - PurchasePWL.java
      - PurchaseSOS2.java
      - TravelingSalesPerson.java
      Parameters:
        `newUb` - The upper bound for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withLimit

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withLimit​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Double> newLimit)

      Set a limit that depends on the index. A limit specifies the bounds for semi-continuous/integer columns or variables and the limit for partial integer columns or variables. It does not apply to columns or variables of other types.

      Examples using `withLimit`:

      - ContractAllocation.java
      Parameters:
        `newLimit` - The limit for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withLimit

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withLimit​(double newLimit)

      Set a constant limit for all columns or variables. A limit specifies the bounds for semi-continuous/integer columns or variables and the limit for partial integer columns or variables. It does not apply to columns or variables of other types.

      Examples using `withLimit`:

      - ContractAllocation.java
      Parameters:
        `newLimit` - The limit for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withName

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withName​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.String> newName)

      Set a name that depends on the index.

      Examples using `withName`:

      - Boxes02.java
      - Capbgt2l.java
      - CuttingStock.java
      - ELS.java
      - ELSCut.java
      - ELSManagedCuts.java
      - FacilityLocationCollection.java
      - FolioCB.java
      - FolioHeuristic.java
      - FolioIIS.java
      - FolioInit.java
      - FolioMip1.java
      - FolioMipIIS.java
      - FolioQC.java
      - FolioQP.java
      - MultipleKnapsack_Arrays.java
      - MultipleKnapsack_Collections.java
      - MultipleProblems.java
      - Polygon.java
      - PolygonMap.java
      - PolygonMapDelta.java
      - PolygonMultiMap.java
      - PolygonMultiMapDelta.java
      - PolygonVecMap.java
      - PolygonVecMapDelta.java
      - RecursiveFinancialPlanning.java
      - Sangraalind.java
      - SpecialOrderedSetsQuadratic.java
      - TravelingSalesPerson.java
      Parameters:
        `newName` - The name for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withName

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withName​(java.lang.String newName)

      Set a constant name for all columns or variables.

      Examples using `withName`:

      - Boxes02.java
      - Capbgt2l.java
      - CuttingStock.java
      - ELS.java
      - ELSCut.java
      - ELSManagedCuts.java
      - FacilityLocationCollection.java
      - FolioCB.java
      - FolioHeuristic.java
      - FolioIIS.java
      - FolioInit.java
      - FolioMip1.java
      - FolioMipIIS.java
      - FolioQC.java
      - FolioQP.java
      - MultipleKnapsack_Arrays.java
      - MultipleKnapsack_Collections.java
      - MultipleProblems.java
      - Polygon.java
      - PolygonMap.java
      - PolygonMapDelta.java
      - PolygonMultiMap.java
      - PolygonMultiMapDelta.java
      - PolygonVecMap.java
      - PolygonVecMapDelta.java
      - RecursiveFinancialPlanning.java
      - Sangraalind.java
      - SpecialOrderedSetsQuadratic.java
      - TravelingSalesPerson.java
      Parameters:
        `newName` - The name for all columns or 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.Map5Builder<K1,​K2,​K3,​K4,​K5> withType​(Function5<K1,​K2,​K3,​K4,​K5,​ColumnType> newType)

      Set a type that depends on the index.

      Examples using `withType`:

      - Boxes02.java
      - ContractAllocation.java
      - ELSManagedCuts.java
      - FacilityLocationArray.java
      - FolioCB.java
      - FolioMip2.java
      - FolioMipIIS.java
      - MultipleKnapsack_Arrays.java
      - MultipleKnapsack_Collections.java
      - Pplan.java
      - TravelingSalesPerson.java
      Parameters:
        `newType` - The type for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withType

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withType​(ColumnType newType)

      Set a constant type for all columns or variables.

      Examples using `withType`:

      - Boxes02.java
      - ContractAllocation.java
      - ELSManagedCuts.java
      - FacilityLocationArray.java
      - FolioCB.java
      - FolioMip2.java
      - FolioMipIIS.java
      - MultipleKnapsack_Arrays.java
      - MultipleKnapsack_Collections.java
      - Pplan.java
      - TravelingSalesPerson.java
      Parameters:
        `newType` - The type for all columns or variables created by this builder.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withFilter

          public VariableBuilder.Map5Builder<K1,​K2,​K3,​K4,​K5> withFilter​(Function5<K1,​K2,​K3,​K4,​K5,​java.lang.Boolean> newFilter)

      Set a filter that selects elements.
      Parameters:
        `newFilter` - Element filter
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### build

          public HashMap5<K1,​K2,​K3,​K4,​K5,​java.lang.Integer> build​(XPRSprob prob)

      Create columns as specified by this builder.
      Parameters:
        `prob` - The problem in which to create the columns.
      Returns:
        The generated columns.
      Since:
        43.00

    - #### build

          public HashMap5<K1,​K2,​K3,​K4,​K5,​Variable> build​(XpressProblem prob)

      Create variables as specified by this builder.
      Parameters:
        `prob` - The problem in which to create the variables.
      Returns:
        The generated variables.
      Since:
        43.00

Parent Topic Class Summary

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