Initializing help system before first use

VariableMap2Builder

Build a 2-dimensional map of variables. More...

Public Member Functions

template<typename Iter_iterable1 , typename Iter_iterable2 , is-iterable(Iter_iterable1) , is-iterable(Iter_iterable2) >
  VariableMap2Builder (Iter_iterable1 const &iterable1, Iter_iterable2 const &iterable2, xpress::objects::XpressProblem *prob)
  Create a builder that will create a 2-dimensional map of variables from the specified data.
 
auto  toMap () -> xpress::maps::HashMap2< K1, K2, 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, K2, 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, K2) >
auto  withFilter (Func_newFilter newFilter) -> VariableMap2Builder< K1, K2 > &
  Set a filter that selects elements.
 
auto  withLB (double newLb) -> VariableMap2Builder< K1, K2 > &
  Set a constant lower bound for all variables.
 
template<typename Func_newLb , is-invocable(Func_newLb, double, K1, K2) >
auto  withLB (Func_newLb newLb) -> VariableMap2Builder< K1, K2 > &
  Set a lower bound that depends on the index.
 
auto  withLimit (double newLimit) -> VariableMap2Builder< K1, K2 > &
  Set a constant limit for all variables.
 
template<typename Func_newLimit , is-invocable(Func_newLimit, double, K1, K2) >
auto  withLimit (Func_newLimit newLimit) -> VariableMap2Builder< K1, K2 > &
  Set a limit that depends on the index.
 
template<typename Func_newName , is-invocable(Func_newName, std::optional< std::string >, K1, K2) >
auto  withName (Func_newName newName) -> VariableMap2Builder< K1, K2 > &
  Set a name that depends on the index.
 
auto  withName (std::optional< std::string > newName) -> VariableMap2Builder< K1, K2 > &
  Set a constant name for all variables.
 
auto  withType (ColumnType newType) -> VariableMap2Builder< K1, K2 > &
  Set a constant type for all variables.
 
template<typename Func_newType , is-invocable(Func_newType, ColumnType, K1, K2) >
auto  withType (Func_newType newType) -> VariableMap2Builder< K1, K2 > &
  Set a type that depends on the index.
 
auto  withUB (double newUb) -> VariableMap2Builder< K1, K2 > &
  Set a constant upper bound for all variables.
 
template<typename Func_newUb , is-invocable(Func_newUb, double, K1, K2) >
auto  withUB (Func_newUb newUb) -> VariableMap2Builder< K1, K2 > &
  Set a upper bound that depends on the index.
 

Detailed Description

template<typename K1, typename K2>
class xpress::VariableBuilder::VariableMap2Builder< K1, K2 >

Build a 2-dimensional map of variables.

Since
44.00

Constructor & Destructor Documentation

VariableMap2Builder()

template<typename K1 , typename K2 >
template<typename Iter_iterable1 , typename Iter_iterable2 , is-iterable(Iter_iterable1) , is-iterable(Iter_iterable2) >
xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::VariableMap2Builder ( Iter_iterable1 const & iterable1,
Iter_iterable2 const & iterable2,
xpress::objects::XpressProblem * prob )
inline

Create a builder that will create a 2-dimensional map of variables from the specified data.

Parameters
iterable1 Data for the builder.
iterable2 Data for the builder.
prob The problem for which to create variables.
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.
Since
44.00

Member Function Documentation

toMap() [1/2]

template<typename K1 , typename K2 >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::toMap ( ) -> xpress::maps::HashMap2<K1 ,K2,xpress::objects::Variable>
inline

Create the variables specified by this builder.

Examples using toMap:

Returns
The created variables.
Since
44.00

toMap() [2/2]

template<typename K1 , typename K2 >
template<typename I , typename Func_makeResult , typename Action_addResult , is-invocable(Func_makeResult, I) , is-invocable(Action_addResult, void, I &, K1, K2, xpress::objects::Variable) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::toMap ( Func_makeResult makeResult,
Action_addResult addResult ) -> I
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 () to I.
Action_addResult auto (I &,K1,K2,xpress::objects::Variable) -> void: Maps (I &,K1,K2,xpress::objects::Variable) to void.
Returns
The created variables.
Since
44.00

withFilter()

template<typename K1 , typename K2 >
template<typename Func_newFilter , is-invocable(Func_newFilter, bool, K1, K2) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withFilter ( Func_newFilter newFilter ) -> VariableMap2Builder<K1,K2>&
inline

Set a filter that selects elements.

Parameters
newFilter Element filter
Template Parameters
Func_newFilter auto (K1,K2) -> bool: Maps (K1,K2) to bool.
Returns
Always returns this instance.
Since
44.00

withLB() [1/2]

template<typename K1 , typename K2 >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withLB ( double newLb ) -> VariableMap2Builder<K1,K2>&
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 , typename K2 >
template<typename Func_newLb , is-invocable(Func_newLb, double, K1, K2) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withLB ( Func_newLb newLb ) -> VariableMap2Builder<K1,K2>&
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,K2) -> double: Maps (K1,K2) to double.
Returns
Always returns this instance.
Since
44.00

withLimit() [1/2]

template<typename K1 , typename K2 >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withLimit ( double newLimit ) -> VariableMap2Builder<K1,K2>&
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 , typename K2 >
template<typename Func_newLimit , is-invocable(Func_newLimit, double, K1, K2) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withLimit ( Func_newLimit newLimit ) -> VariableMap2Builder<K1,K2>&
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,K2) -> double: Maps (K1,K2) to double.
Returns
Always returns this instance.
Since
44.00

withName() [1/2]

template<typename K1 , typename K2 >
template<typename Func_newName , is-invocable(Func_newName, std::optional< std::string >, K1, K2) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withName ( Func_newName newName ) -> VariableMap2Builder<K1,K2>&
inline

withName() [2/2]

template<typename K1 , typename K2 >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withName ( std::optional< std::string > newName ) -> VariableMap2Builder<K1,K2>&
inline

withType() [1/2]

withType() [2/2]

template<typename K1 , typename K2 >
template<typename Func_newType , is-invocable(Func_newType, ColumnType, K1, K2) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withType ( Func_newType newType ) -> VariableMap2Builder<K1,K2>&
inline

Set a type that depends on the index.

Examples using withType:

Parameters
newType The type for all variables created by this builder.
Template Parameters
Func_newType auto (K1,K2) -> ColumnType: Maps (K1,K2) to ColumnType.
Returns
Always returns this instance.
Since
44.00

withUB() [1/2]

template<typename K1 , typename K2 >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withUB ( double newUb ) -> VariableMap2Builder<K1,K2>&
inline

Set a constant upper bound for all variables.

Examples using withUB:

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 , typename K2 >
template<typename Func_newUb , is-invocable(Func_newUb, double, K1, K2) >
auto xpress::VariableBuilder::VariableMap2Builder< K1, K2 >::withUB ( Func_newUb newUb ) -> VariableMap2Builder<K1,K2>&
inline

Set a upper bound that depends on the index.

Examples using withUB:

Parameters
newUb The upper bound for all variables created by this builder.
Template Parameters
Func_newUb auto (K1,K2) -> double: Maps (K1,K2) to double.
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.