Initializing help system before first use

# Map3Builder

Build a 3-dimensional map of columns or variables. More...

## Public Member Functions
template<typename Iter_iterable1 , typename Iter_iterable2 , typename Iter_iterable3 , is-iterable(Iter_iterable1) , is-iterable(Iter_iterable2) , is-iterable(Iter_iterable3) >
| Map3Builder (Iter_iterable1 const &iterable1, Iter_iterable2 const &iterable2, Iter_iterable3 const &iterable3)
| Create a builder that will create a 3-dimensional map of columns or variables from the specified data.
auto | build (xpress::objects::XpressProblem *prob) -> xpress::maps::HashMap3< K1, K2, K3, xpress::objects::Variable >
| Create variables as specified by this builder.
auto | build (XPRSProblem *prob) -> xpress::maps::HashMap3< K1, K2, K3, int >
| Create columns as specified by this builder.
template<typename Func_newFilter , is-invocable(Func_newFilter, bool, K1, K2, K3) >
auto | withFilter (Func_newFilter newFilter) -> Map3Builder< K1, K2, K3 > &
| Set a filter that selects elements.
auto | withLB (double newLb) -> Map3Builder< K1, K2, K3 > &
| Set a constant lower bound for all columns or variables.
template<typename Func_newLb , is-invocable(Func_newLb, double, K1, K2, K3) >
auto | withLB (Func_newLb newLb) -> Map3Builder< K1, K2, K3 > &
| Set a lower bound that depends on the index.
auto | withLimit (double newLimit) -> Map3Builder< K1, K2, K3 > &
| Set a constant limit for all columns or variables.
template<typename Func_newLimit , is-invocable(Func_newLimit, double, K1, K2, K3) >
auto | withLimit (Func_newLimit newLimit) -> Map3Builder< K1, K2, K3 > &
| Set a limit that depends on the index.
template<typename Func_newName , is-invocable(Func_newName, std::optional< std::string >, K1, K2, K3) >
auto | withName (Func_newName newName) -> Map3Builder< K1, K2, K3 > &
| Set a name that depends on the index.
auto | withName (std::optional< std::string > newName) -> Map3Builder< K1, K2, K3 > &
| Set a constant name for all columns or variables.
auto | withType (ColumnType newType) -> Map3Builder< K1, K2, K3 > &
| Set a constant type for all columns or variables.
template<typename Func_newType , is-invocable(Func_newType, ColumnType, K1, K2, K3) >
auto | withType (Func_newType newType) -> Map3Builder< K1, K2, K3 > &
| Set a type that depends on the index.
auto | withUB (double newUb) -> Map3Builder< K1, K2, K3 > &
| Set a constant upper bound for all columns or variables.
template<typename Func_newUb , is-invocable(Func_newUb, double, K1, K2, K3) >
auto | withUB (Func_newUb newUb) -> Map3Builder< K1, K2, K3 > &
| Set a upper bound that depends on the index.

## Detailed Description

template<typename K1, typename K2, typename K3>
class xpress::VariableBuilder::Map3Builder< K1, K2, K3 >

Build a 3-dimensional map of columns or variables.

Since
  44.00

## Constructor & Destructor Documentation

## Map3Builder()

template<typename K1 , typename K2 , typename K3 >
template<typename Iter_iterable1 , typename Iter_iterable2 , typename Iter_iterable3 , is-iterable(Iter_iterable1) , is-iterable(Iter_iterable2) , is-iterable(Iter_iterable3) >

xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::Map3Builder | ( | Iter_iterable1 const & | iterable1,
|  | Iter_iterable2 const & | iterable2,
|  | Iter_iterable3 const & | iterable3 )
| inline

Create a builder that will create a 3-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.

Template Parameters

  Iter_iterable1 | Something that supports `begin()` and `end()` and contains values of type `K1`.
  Iter_iterable2 | Something that supports `begin()` and `end()` and contains values of type `K2`.
  Iter_iterable3 | Something that supports `begin()` and `end()` and contains values of type `K3`.

Since
  44.00

## Member Function Documentation

## build() [1/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::build | ( | xpress::objects::XpressProblem * | prob | ) | -> xpress::maps::HashMap3<K1 ,K2 ,K3,xpress::objects::Variable>
| inline

Create variables as specified by this builder.

Parameters

  prob | The problem in which to create the variables.

Returns
  The generated variables.

Since
  44.00

## build() [2/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::build | ( | XPRSProblem * | prob | ) | -> xpress::maps::HashMap3<K1 ,K2 ,K3,int>
| inline

Create columns as specified by this builder.

Parameters

  prob | The problem in which to create the columns.

Returns
  The generated columns.

Since
  44.00

## withFilter()

template<typename K1 , typename K2 , typename K3 >
template<typename Func_newFilter , is-invocable(Func_newFilter, bool, K1, K2, K3) >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withFilter | ( | Func_newFilter | newFilter | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a filter that selects elements.

Parameters

  newFilter | Element filter

Template Parameters

  Func_newFilter | `auto (K1,K2,K3) -> bool`: Maps `(K1,K2,K3)` to `bool`.

Returns
  Always returns this instance.

Since
  44.00

## withLB() [1/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withLB | ( | double | newLb | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a constant lower bound for all columns or variables.

Examples using `withLB`:

- Catenary.cpp
- CuttingStock.cpp
- FolioMipIIS.cpp
- Glidert.cpp
- RecursiveFinancialPlanning.cpp

Parameters

  newLb | The lower bound for all columns or variables created by this builder.

Returns
  Always returns this instance.

Since
  44.00

## withLB() [2/2]

template<typename K1 , typename K2 , typename K3 >
template<typename Func_newLb , is-invocable(Func_newLb, double, K1, K2, K3) >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withLB | ( | Func_newLb | newLb | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a lower bound that depends on the index.

Examples using `withLB`:

- Catenary.cpp
- CuttingStock.cpp
- FolioMipIIS.cpp
- Glidert.cpp
- RecursiveFinancialPlanning.cpp

Parameters

  newLb | The lower bound for all columns or variables created by this builder.

Template Parameters

  Func_newLb | `auto (K1,K2,K3) -> double`: Maps `(K1,K2,K3)` to `double`.

Returns
  Always returns this instance.

Since
  44.00

## withLimit() [1/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withLimit | ( | double | newLimit | ) | -> Map3Builder<K1,K2,K3>&
| inline

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.cpp
- FolioMip2.cpp

Parameters

  newLimit | The limit for all columns or variables created by this builder.

Returns
  Always returns this instance.

Since
  44.00

## withLimit() [2/2]

template<typename K1 , typename K2 , typename K3 >
template<typename Func_newLimit , is-invocable(Func_newLimit, double, K1, K2, K3) >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withLimit | ( | Func_newLimit | newLimit | ) | -> Map3Builder<K1,K2,K3>&
| inline

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.cpp
- FolioMip2.cpp

Parameters

  newLimit | The limit for all columns or variables created by this builder.

Template Parameters

  Func_newLimit | `auto (K1,K2,K3) -> double`: Maps `(K1,K2,K3)` to `double`.

Returns
  Always returns this instance.

Since
  44.00

## withName() [1/2]

template<typename K1 , typename K2 , typename K3 >
template<typename Func_newName , is-invocable(Func_newName, std::optional< std::string >, K1, K2, K3) >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withName | ( | Func_newName | newName | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a name that depends on the index.

Examples using `withName`:

- BinBurglar.cpp
- BoolVars.cpp
- Boxes02.cpp
- Capbgt2l.cpp
- CapitalBudgeting.cpp
- Catenary.cpp
- ContractAllocation.cpp
- CuttingStock.cpp
- ELS.cpp
- ELSCut.cpp
- ELSManagedCuts.cpp
- FacilityLocationArray.cpp
- FacilityLocationCollection.cpp
- Folio.cpp
- FolioCB.cpp
- FolioHeuristic.cpp
- FolioIIS.cpp
- FolioInit.cpp
- FolioMip1.cpp
- FolioMip2.cpp
- FolioMipIIS.cpp
- FolioQC.cpp
- FolioQP.cpp
- Glidert.cpp
- MultipleKnapsack_Arrays.cpp
- MultipleKnapsack_Collections.cpp
- Pplan.cpp
- Pplan2.cpp
- ProductionPlanning_Index.cpp
- PurchasePWL.cpp
- PurchaseSOS2.cpp
- RecursiveFinancialPlanning.cpp
- Sangraalind.cpp
- SpecialOrderedSetsQuadratic.cpp
- TravelingSalesPerson.cpp
- Wagon.cpp

Parameters

  newName | The name for all columns or variables created by this builder.

Template Parameters

  Func_newName | `auto (K1,K2,K3) -> std::optional<std::string>`: Maps `(K1,K2,K3)` to `std::optional<std::string>`.

Returns
  Always returns this instance.

Since
  44.00

## withName() [2/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withName | ( | std::optional< std::string > | newName | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a constant name for all columns or variables.

Examples using `withName`:

- BinBurglar.cpp
- BoolVars.cpp
- Boxes02.cpp
- Capbgt2l.cpp
- CapitalBudgeting.cpp
- Catenary.cpp
- ContractAllocation.cpp
- CuttingStock.cpp
- ELS.cpp
- ELSCut.cpp
- ELSManagedCuts.cpp
- FacilityLocationArray.cpp
- FacilityLocationCollection.cpp
- Folio.cpp
- FolioCB.cpp
- FolioHeuristic.cpp
- FolioIIS.cpp
- FolioInit.cpp
- FolioMip1.cpp
- FolioMip2.cpp
- FolioMipIIS.cpp
- FolioQC.cpp
- FolioQP.cpp
- Glidert.cpp
- MultipleKnapsack_Arrays.cpp
- MultipleKnapsack_Collections.cpp
- Pplan.cpp
- Pplan2.cpp
- ProductionPlanning_Index.cpp
- PurchasePWL.cpp
- PurchaseSOS2.cpp
- RecursiveFinancialPlanning.cpp
- Sangraalind.cpp
- SpecialOrderedSetsQuadratic.cpp
- TravelingSalesPerson.cpp
- Wagon.cpp

Parameters

  newName | The name for all columns or variables created by this builder. This must be `std::nullopt` or a format string that will be invoked with the index as argument.

Returns
  Always returns this instance.

Since
  44.00

## withType() [1/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withType | ( | ColumnType | newType | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a constant type for all columns or variables.

Examples using `withType`:

- BinBurglar.cpp
- BoolVars.cpp
- Boxes02.cpp
- Capbgt2l.cpp
- CapitalBudgeting.cpp
- ContractAllocation.cpp
- CuttingStock.cpp
- ELS.cpp
- ELSCut.cpp
- ELSManagedCuts.cpp
- FacilityLocationArray.cpp
- FacilityLocationCollection.cpp
- Folio.cpp
- FolioCB.cpp
- FolioHeuristic.cpp
- FolioIIS.cpp
- FolioMip1.cpp
- FolioMip2.cpp
- FolioMipIIS.cpp
- FolioQP.cpp
- MultipleKnapsack_Arrays.cpp
- MultipleKnapsack_Collections.cpp
- Pplan.cpp
- ProductionPlanning_Index.cpp
- Sangraalind.cpp
- TravelingSalesPerson.cpp
- Wagon.cpp

Parameters

  newType | The type for all columns or variables created by this builder.

Returns
  Always returns this instance.

Since
  44.00

## withType() [2/2]

template<typename K1 , typename K2 , typename K3 >
template<typename Func_newType , is-invocable(Func_newType, ColumnType, K1, K2, K3) >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withType | ( | Func_newType | newType | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a type that depends on the index.

Examples using `withType`:

- BinBurglar.cpp
- BoolVars.cpp
- Boxes02.cpp
- Capbgt2l.cpp
- CapitalBudgeting.cpp
- ContractAllocation.cpp
- CuttingStock.cpp
- ELS.cpp
- ELSCut.cpp
- ELSManagedCuts.cpp
- FacilityLocationArray.cpp
- FacilityLocationCollection.cpp
- Folio.cpp
- FolioCB.cpp
- FolioHeuristic.cpp
- FolioIIS.cpp
- FolioMip1.cpp
- FolioMip2.cpp
- FolioMipIIS.cpp
- FolioQP.cpp
- MultipleKnapsack_Arrays.cpp
- MultipleKnapsack_Collections.cpp
- Pplan.cpp
- ProductionPlanning_Index.cpp
- Sangraalind.cpp
- TravelingSalesPerson.cpp
- Wagon.cpp

Parameters

  newType | The type for all columns or variables created by this builder.

Template Parameters

  Func_newType | `auto (K1,K2,K3) -> ColumnType`: Maps `(K1,K2,K3)` to `ColumnType`.

Returns
  Always returns this instance.

Since
  44.00

## withUB() [1/2]

template<typename K1 , typename K2 , typename K3 >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withUB | ( | double | newUb | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a constant upper bound for all columns or variables.

Examples using `withUB`:

- Boxes02.cpp
- ContractAllocation.cpp
- CuttingStock.cpp
- Folio.cpp
- FolioCB.cpp
- FolioHeuristic.cpp
- FolioIIS.cpp
- FolioInit.cpp
- FolioMip1.cpp
- FolioMip2.cpp
- FolioMipIIS.cpp
- FolioQC.cpp
- FolioQP.cpp
- Glidert.cpp
- PurchasePWL.cpp
- PurchaseSOS2.cpp
- SpecialOrderedSetsQuadratic.cpp
- TravelingSalesPerson.cpp

Parameters

  newUb | The upper bound for all columns or variables created by this builder.

Returns
  Always returns this instance.

Since
  44.00

## withUB() [2/2]

template<typename K1 , typename K2 , typename K3 >
template<typename Func_newUb , is-invocable(Func_newUb, double, K1, K2, K3) >

auto xpress::VariableBuilder::Map3Builder< K1, K2, K3 >::withUB | ( | Func_newUb | newUb | ) | -> Map3Builder<K1,K2,K3>&
| inline

Set a upper bound that depends on the index.

Examples using `withUB`:

- Boxes02.cpp
- ContractAllocation.cpp
- CuttingStock.cpp
- Folio.cpp
- FolioCB.cpp
- FolioHeuristic.cpp
- FolioIIS.cpp
- FolioInit.cpp
- FolioMip1.cpp
- FolioMip2.cpp
- FolioMipIIS.cpp
- FolioQC.cpp
- FolioQP.cpp
- Glidert.cpp
- PurchasePWL.cpp
- PurchaseSOS2.cpp
- SpecialOrderedSetsQuadratic.cpp
- TravelingSalesPerson.cpp

Parameters

  newUb | The upper bound for all columns or variables created by this builder.

Template Parameters

  Func_newUb | `auto (K1,K2,K3) -> double`: Maps `(K1,K2,K3)` to `double`.

Returns
  Always returns this instance.

Since
  44.00

The documentation for this class was generated from the following file:

- xpress.hpp

Parent Topic VariableBuilder

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