Initializing help system before first use

VariableArray3Builder

Build a 3-dimensional array of variables. More...

#include <xpress.hpp>

Public Member Functions
  VariableArray3Builder (int dim1, int dim2, int dim3, xpress::objects::XpressProblem *prob)
  Create a builder that will create a 3-dimensional array of variables with the specified dimensions.
 
auto  toArray () -> std::vector< std::vector< std::vector< xpress::objects::Variable > > >
  Create variables as specified by this builder.
 
template<typename I , typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0>::type,I>::value>::type>
auto  toArray (Func0 makeResult, std::function< void(I, int, int, int, xpress::objects::Variable)> addResult) -> I
  Create variables as specified by this builder.
 
auto  withLB (double newLb) -> VariableArray3Builder &
  Set a constant lower bound for all variables.
 
template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,double>::value>::type>
auto  withLB (Func0 newLb) -> VariableArray3Builder &
  Set a lower bound that depends on the index.
 
auto  withLimit (double newLimit) -> VariableArray3Builder &
  Set a constant limit for all variables.
 
template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,double>::value>::type>
auto  withLimit (Func0 newLimit) -> VariableArray3Builder &
  Set a limit that depends on the index.
 
template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,std::optional<std::string>>::value>::type>
auto  withName (Func0 newName) -> VariableArray3Builder &
  Set a name that depends on the index.
 
auto  withName (std::optional< std::string > newName) -> VariableArray3Builder &
  Set a constant name for all variables.
 
auto  withType (ColumnType newType) -> VariableArray3Builder &
  Set the type for all variables.
 
template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,ColumnType>::value>::type>
auto  withType (Func0 newType) -> VariableArray3Builder &
  Set a type that depends on the index.
 
auto  withUB (double newUb) -> VariableArray3Builder &
  Set a constant upper bound for all variables.
 
template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,double>::value>::type>
auto  withUB (Func0 newUb) -> VariableArray3Builder &
  Set a upper bound that depends on the index.
 

Detailed Description

Build a 3-dimensional array of variables.

Since
44.00

Constructor & Destructor Documentation

VariableArray3Builder()

xpress::VariableBuilder::VariableArray3Builder::VariableArray3Builder ( int dim1,
int dim2,
int dim3,
xpress::objects::XpressProblem * prob )
inline

Create a builder that will create a 3-dimensional array of variables with the specified dimensions.

Parameters
dim1 Dimension 1.
dim2 Dimension 2.
dim3 Dimension 3.
prob The problem for which to create variables.
Since
44.00

Member Function Documentation

toArray() [1/2]

auto xpress::VariableBuilder::VariableArray3Builder::toArray ( ) -> std::vector< std::vector< std::vector<xpress::objects::Variable> > >
inline

Create variables as specified by this builder.

Since
44.00

toArray() [2/2]

template<typename I , typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0>::type,I>::value>::type>
auto xpress::VariableBuilder::VariableArray3Builder::toArray ( Func0 makeResult,
std::function< void(I, int, int, int, xpress::objects::Variable)> addResult ) -> I
inline

Create variables as specified by this builder.

Parameters
makeResult A function to create the (empty) return value.
addResult A function to add a value to the result.
Template Parameters
I Type of return value.
Func0 auto () -> I: Maps () to I.
Returns
The array of variables.
Since
44.00

withLB() [1/2]

auto xpress::VariableBuilder::VariableArray3Builder::withLB ( double newLb ) -> VariableArray3Builder&
inline

Set a constant lower bound for all variables.

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 Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,double>::value>::type>
auto xpress::VariableBuilder::VariableArray3Builder::withLB ( Func0 newLb ) -> VariableArray3Builder&
inline

Set a lower bound that depends on the index.

Parameters
newLb The lower bound for all variables created by this builder.
Template Parameters
Func0 auto (int,int,int) -> double: Maps (int,int,int) to double.
Returns
Always returns this instance.
Since
44.00

withLimit() [1/2]

auto xpress::VariableBuilder::VariableArray3Builder::withLimit ( double newLimit ) -> VariableArray3Builder&
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.

Parameters
newLimit The limit for all variables created by this builder.
Returns
Always returns this instance.
Since
44.00

withLimit() [2/2]

template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,double>::value>::type>
auto xpress::VariableBuilder::VariableArray3Builder::withLimit ( Func0 newLimit ) -> VariableArray3Builder&
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.

Parameters
newLimit The limit for all variables created by this builder.
Template Parameters
Func0 auto (int,int,int) -> double: Maps (int,int,int) to double.
Returns
Always returns this instance.
Since
44.00

withName() [1/2]

template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,std::optional<std::string>>::value>::type>
auto xpress::VariableBuilder::VariableArray3Builder::withName ( Func0 newName ) -> VariableArray3Builder&
inline

Set a name that depends on the index.

Parameters
newName The name for all variables created by this builder.
Template Parameters
Func0 auto (int,int,int) -> std::optional<std::string>: Maps (int,int,int) to std::optional<std::string>.
Returns
Always returns this instance.
Since
44.00

withName() [2/2]

auto xpress::VariableBuilder::VariableArray3Builder::withName ( std::optional< std::string > newName ) -> VariableArray3Builder&
inline

Set a constant name for all variables.

Parameters
newName The name for all 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]

auto xpress::VariableBuilder::VariableArray3Builder::withType ( ColumnType newType ) -> VariableArray3Builder&
inline

Set the type for all variables.

Parameters
newType The type for all variables created by this builder.
Returns
Always returns this instance.
Since
44.00

withType() [2/2]

template<typename Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,ColumnType>::value>::type>
auto xpress::VariableBuilder::VariableArray3Builder::withType ( Func0 newType ) -> VariableArray3Builder&
inline

Set a type that depends on the index.

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

withUB() [1/2]

auto xpress::VariableBuilder::VariableArray3Builder::withUB ( double newUb ) -> VariableArray3Builder&
inline

Set a constant upper bound for all variables.

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 Func0 , typename Func0Invocable = typename std::enable_if<std::is_convertible<typename std::invoke_result<Func0,int,int,int>::type,double>::value>::type>
auto xpress::VariableBuilder::VariableArray3Builder::withUB ( Func0 newUb ) -> VariableArray3Builder&
inline

Set a upper bound that depends on the index.

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