Initializing help system before first use

# VariableBuilder.Array3Builder

- java.lang.Object
- - com.dashoptimization.VariableBuilder.Array3Builder

- Enclosing class:
    VariableBuilder

      public static final class VariableBuilder.Array3Builder
      extends java.lang.Object

  Build a 3-dimensional array of columns or variables.
  Since:
    43.00

- - ### Constructor Summary

    Constructor | Description
    --- | ---
    `Array3Builder​(int dim1, int dim2, int dim3)` | Create a builder that will create a multi-dimensional array of columns or variables with the specified dimensions.

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `Variable[][][]` | `build​(XpressProblem prob)` | Create variables as specified by this builder.
    `int[][][]` | `build​(XPRSprob prob)` | Create columns as specified by this builder.
    `VariableBuilder.Array3Builder` | `withLB​(double newLb)` | Set a constant lower bound for all columns or variables.
    `VariableBuilder.Array3Builder` | `withLB​(double[][][] newLb)` | Set a lower bound that is given by an array.
    `VariableBuilder.Array3Builder` | `withLB​(IntFunction3<java.lang.Double> newLb)` | Set a lower bound that depends on the index.
    `VariableBuilder.Array3Builder` | `withLimit​(double newLimit)` | Set a constant limit for all columns or variables.
    `VariableBuilder.Array3Builder` | `withLimit​(double[][][] newLimit)` | Set a limit that is given by an array.
    `VariableBuilder.Array3Builder` | `withLimit​(IntFunction3<java.lang.Double> newLimit)` | Set a limit that depends on the index.
    `VariableBuilder.Array3Builder` | `withName​(IntFunction3<java.lang.String> newName)` | Set a name that depends on the index.
    `VariableBuilder.Array3Builder` | `withName​(java.lang.String newName)` | Set a constant name for all columns or variables.
    `VariableBuilder.Array3Builder` | `withName​(java.lang.String[][][] newName)` | Set a name bound that is given by an array.
    `VariableBuilder.Array3Builder` | `withType​(ColumnType newType)` | Set the type for all columns or variables.
    `VariableBuilder.Array3Builder` | `withType​(ColumnType[][][] newType)` | Set a type that is given by an array.
    `VariableBuilder.Array3Builder` | `withType​(IntFunction3<ColumnType> newType)` | Set a type that depends on the index.
    `VariableBuilder.Array3Builder` | `withUB​(double newUb)` | Set a constant upper bound for all columns or variables.
    `VariableBuilder.Array3Builder` | `withUB​(double[][][] newUb)` | Set an upper bound that is given by an array.
    `VariableBuilder.Array3Builder` | `withUB​(IntFunction3<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

    - #### Array3Builder

          public Array3Builder​(int dim1,
                               int dim2,
                               int dim3)

      Create a builder that will create a multi-dimensional array of columns or variables with the specified dimensions.
      Parameters:
        `dim1` - Dimension 1.
        `dim2` - Dimension 2.
        `dim3` - Dimension 3.
      Since:
        43.00

  - ### Method Detail

    - #### withLB

          public VariableBuilder.Array3Builder withLB​(IntFunction3<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.Array3Builder 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

    - #### withLB

          public VariableBuilder.Array3Builder withLB​(double[][][] newLb)

      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.

      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` - Lower bounds for the individual columns or variables.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withUB

          public VariableBuilder.Array3Builder withUB​(IntFunction3<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.Array3Builder 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

    - #### withUB

          public VariableBuilder.Array3Builder withUB​(double[][][] newUb)

      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.

      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` - Upper bounds for the individual columns or variables.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withLimit

          public VariableBuilder.Array3Builder withLimit​(IntFunction3<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.Array3Builder 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

    - #### withLimit

          public VariableBuilder.Array3Builder withLimit​(double[][][] newLimit)

      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.

      Examples using `withLimit`:

      - ContractAllocation.java
      Parameters:
        `newLimit` - Limits for the individual columns or variables.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withName

          public VariableBuilder.Array3Builder withName​(IntFunction3<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.Array3Builder 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

    - #### withName

          public VariableBuilder.Array3Builder withName​(java.lang.String[][][] newName)

      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.

      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` - Names for the individual columns or variables.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### withType

          public VariableBuilder.Array3Builder withType​(IntFunction3<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.Array3Builder withType​(ColumnType newType)

      Set the 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

    - #### withType

          public VariableBuilder.Array3Builder withType​(ColumnType[][][] newType)

      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.

      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` - Types for the individual columns or variables.
      Returns:
        Always returns this instance.
      Since:
        43.00

    - #### build

          public int[][][] build​(XPRSprob prob)

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

    - #### build

          public 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.