VariableMapBuilder
Build a 1-dimensional map of variables. More...
Public Member Functions |
|
| template<typename Iter_iterable1 , is-iterable(Iter_iterable1) > | |
| VariableMapBuilder (Iter_iterable1 const &iterable1, xpress::objects::XpressProblem *prob) | |
| Create a builder that will create a 1-dimensional map of variables from the specified data. |
|
| auto | toMap () -> std::unordered_map< K1, xpress::objects::Variable > |
| Create the variables specified by this builder. |
|
| template<typename I , typename Func_makeResult , typename Action_addResult , is-invocable(Func_makeResult, I) , is-invocable(Action_addResult, void, I &, K1, xpress::objects::Variable) > | |
| auto | toMap (Func_makeResult makeResult, Action_addResult addResult) -> I |
| Create the variables specified by this builder. |
|
| template<typename Func_newFilter , is-invocable(Func_newFilter, bool, K1) > | |
| auto | withFilter (Func_newFilter newFilter) -> VariableMapBuilder< K1 > & |
| Set a filter that selects elements. |
|
| auto | withLB (double newLb) -> VariableMapBuilder< K1 > & |
| Set a constant lower bound for all variables. |
|
| template<typename Func_newLb , is-invocable(Func_newLb, double, K1) > | |
| auto | withLB (Func_newLb newLb) -> VariableMapBuilder< K1 > & |
| Set a lower bound that depends on the index. |
|
| auto | withLimit (double newLimit) -> VariableMapBuilder< K1 > & |
| Set a constant limit for all variables. |
|
| template<typename Func_newLimit , is-invocable(Func_newLimit, double, K1) > | |
| auto | withLimit (Func_newLimit newLimit) -> VariableMapBuilder< K1 > & |
| Set a limit that depends on the index. |
|
| template<typename Func_newName , is-invocable(Func_newName, std::optional< std::string >, K1) > | |
| auto | withName (Func_newName newName) -> VariableMapBuilder< K1 > & |
| Set a name that depends on the index. |
|
| auto | withName (std::optional< std::string > newName) -> VariableMapBuilder< K1 > & |
| Set a constant name for all variables. |
|
| auto | withType (ColumnType newType) -> VariableMapBuilder< K1 > & |
| Set a constant type for all variables. |
|
| template<typename Func_newType , is-invocable(Func_newType, ColumnType, K1) > | |
| auto | withType (Func_newType newType) -> VariableMapBuilder< K1 > & |
| Set a type that depends on the index. |
|
| auto | withUB (double newUb) -> VariableMapBuilder< K1 > & |
| Set a constant upper bound for all variables. |
|
| template<typename Func_newUb , is-invocable(Func_newUb, double, K1) > | |
| auto | withUB (Func_newUb newUb) -> VariableMapBuilder< K1 > & |
| Set a upper bound that depends on the index. |
|
Detailed Description
template<typename K1>
class xpress::VariableBuilder::VariableMapBuilder< K1 >
class xpress::VariableBuilder::VariableMapBuilder< K1 >
Build a 1-dimensional map of variables.
- Since
- 44.00
Constructor & Destructor Documentation
VariableMapBuilder()
template<typename K1 >
template<typename Iter_iterable1 , is-iterable(Iter_iterable1) >
|
inline |
Create a builder that will create a 1-dimensional map of variables from the specified data.
- Parameters
-
iterable1 Data for the builder. prob The problem for which to create variables.
- Template Parameters
-
Iter_iterable1 Something that supports begin()andend()and contains values of typeK1.
- Since
- 44.00
Member Function Documentation
toMap() [1/2]
template<typename K1 >
|
inline |
Create the variables specified by this builder.
Examples using toMap:
- Returns
- The created variables.
- Since
- 44.00
toMap() [2/2]
template<typename K1 >
template<typename I , typename Func_makeResult , typename Action_addResult , is-invocable(Func_makeResult, I) , is-invocable(Action_addResult, void, I &, K1,
xpress::objects::Variable) >
|
inline |
Create the variables specified by this builder.
Examples using toMap:
- Parameters
-
makeResult Function to create an (empty) result. addResult Function to add an element to the result.
- Template Parameters
-
I Type of result Func_makeResult auto () -> I: Maps()toI.Action_addResult auto (I &,K1,xpress::objects::Variable) -> void: Maps(I &,K1,xpress::objects::Variable)tovoid.
- Returns
- The created variables.
- Since
- 44.00
withFilter()
template<typename K1 >
template<typename Func_newFilter , is-invocable(Func_newFilter, bool, K1) >
|
inline |
Set a filter that selects elements.
- Parameters
-
newFilter Element filter
- Template Parameters
-
Func_newFilter auto (K1) -> bool: Maps(K1)tobool.
- Returns
- Always returns this instance.
- Since
- 44.00
withLB() [1/2]
template<typename K1 >
|
inline |
Set a constant lower bound for all variables.
Examples using withLB:
- Parameters
-
newLb The lower bound for all variables created by this builder.
- Returns
- Always returns this instance.
- Since
- 44.00
withLB() [2/2]
template<typename K1 >
template<typename Func_newLb , is-invocable(Func_newLb, double, K1) >
|
inline |
Set a lower bound that depends on the index.
Examples using withLB:
- Parameters
-
newLb The lower bound for all variables created by this builder.
- Template Parameters
-
Func_newLb auto (K1) -> double: Maps(K1)todouble.
- Returns
- Always returns this instance.
- Since
- 44.00
withLimit() [1/2]
template<typename K1 >
|
inline |
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.
Examples using withLimit:
- Parameters
-
newLimit The limit for all variables created by this builder.
- Returns
- Always returns this instance.
- Since
- 44.00
withLimit() [2/2]
template<typename K1 >
template<typename Func_newLimit , is-invocable(Func_newLimit, double, K1) >
|
inline |
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.
Examples using withLimit:
- Parameters
-
newLimit The limit for all variables created by this builder.
- Template Parameters
-
Func_newLimit auto (K1) -> double: Maps(K1)todouble.
- Returns
- Always returns this instance.
- Since
- 44.00
withName() [1/2]
template<typename K1 >
template<typename Func_newName , is-invocable(Func_newName, std::optional< std::string >, K1) >
|
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 variables created by this builder.
- Template Parameters
-
Func_newName auto (K1) -> std::optional<std::string>: Maps(K1)tostd::optional<std::string>.
- Returns
- Always returns this instance.
- Since
- 44.00
withName() [2/2]
template<typename K1 >
|
inline |
Set a constant name for all 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 variables created by this builder. This must be std::nulloptor 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 >
|
inline |
Set a constant type for all 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 variables created by this builder.
- Returns
- Always returns this instance.
- Since
- 44.00
withType() [2/2]
template<typename K1 >
template<typename Func_newType , is-invocable(Func_newType,
ColumnType, K1) >
|
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 variables created by this builder.
- Template Parameters
-
Func_newType auto (K1) -> ColumnType: Maps(K1)toColumnType.
- Returns
- Always returns this instance.
- Since
- 44.00
withUB() [1/2]
template<typename K1 >
|
inline |
Set a constant upper bound for all 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 variables created by this builder.
- Returns
- Always returns this instance.
- Since
- 44.00
withUB() [2/2]
template<typename K1 >
template<typename Func_newUb , is-invocable(Func_newUb, double, K1) >
|
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 variables created by this builder.
- Template Parameters
-
Func_newUb auto (K1) -> double: Maps(K1)todouble.
- Returns
- Always returns this instance.
- Since
- 44.00
The documentation for this class was generated from the following file:
- xpress.hpp
© 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.