Initializing help system before first use

VariableBuilder

Builders for creating arrays or maps of variables. More...

#include <xpress.hpp>

Classes
class   Array2Builder
  Build a 2-dimensional array of columns or variables. More...
 
class   Array3Builder
  Build a 3-dimensional array of columns or variables. More...
 
class   Array4Builder
  Build a 4-dimensional array of columns or variables. More...
 
class   Array5Builder
  Build a 5-dimensional array of columns or variables. More...
 
class   ArrayBuilder
  Build a 1-dimensional array of columns or variables. More...
 
class   ColumnArray2Builder
  Build a 2-dimensional array of columns. More...
 
class   ColumnArray3Builder
  Build a 3-dimensional array of columns. More...
 
class   ColumnArray4Builder
  Build a 4-dimensional array of columns. More...
 
class   ColumnArray5Builder
  Build a 5-dimensional array of columns. More...
 
class   ColumnArrayBuilder
  Build a 1-dimensional array of columns. More...
 
class   ColumnMap2Builder
  Build a 2-dimensional map of columns. More...
 
class   ColumnMap3Builder
  Build a 3-dimensional map of columns. More...
 
class   ColumnMap4Builder
  Build a 4-dimensional map of columns. More...
 
class   ColumnMap5Builder
  Build a 5-dimensional map of columns. More...
 
class   ColumnMapBuilder
  Build a 1-dimensional map of columns. More...
 
class   Map2Builder
  Build a 2-dimensional map of columns or variables. More...
 
class   Map3Builder
  Build a 3-dimensional map of columns or variables. More...
 
class   Map4Builder
  Build a 4-dimensional map of columns or variables. More...
 
class   Map5Builder
  Build a 5-dimensional map of columns or variables. More...
 
class   MapBuilder
  Build a 1-dimensional map of columns or variables. More...
 
class   VariableArray2Builder
  Build a 2-dimensional array of variables. More...
 
class   VariableArray3Builder
  Build a 3-dimensional array of variables. More...
 
class   VariableArray4Builder
  Build a 4-dimensional array of variables. More...
 
class   VariableArray5Builder
  Build a 5-dimensional array of variables. More...
 
class   VariableArrayBuilder
  Build a 1-dimensional array of variables. More...
 
class   VariableMap2Builder
  Build a 2-dimensional map of variables. More...
 
class   VariableMap3Builder
  Build a 3-dimensional map of variables. More...
 
class   VariableMap4Builder
  Build a 4-dimensional map of variables. More...
 
class   VariableMap5Builder
  Build a 5-dimensional map of variables. More...
 
class   VariableMapBuilder
  Build a 1-dimensional map of variables. More...
 

Static Public Member Functions
static auto  array (int dim) -> xpress::VariableBuilder::ArrayBuilder
  Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.
 
static auto  array2 (int dim1, int dim2) -> xpress::VariableBuilder::Array2Builder
  Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.
 
static auto  array3 (int dim1, int dim2, int dim3) -> xpress::VariableBuilder::Array3Builder
  Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.
 
static auto  array4 (int dim1, int dim2, int dim3, int dim4) -> xpress::VariableBuilder::Array4Builder
  Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.
 
static auto  array5 (int dim1, int dim2, int dim3, int dim4, int dim5) -> xpress::VariableBuilder::Array5Builder
  Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.
 
template<typename Coll0 , typename K1 = typename Coll0::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type>
static auto  map (Coll0 const &coll1) -> xpress::VariableBuilder::MapBuilder< K1 >
  Create a builder that will create a 1-dimensional map of columns or variables from the specified data.
 
template<typename K1 >
static auto  map (xpress::SizedArray< K1 const > const &arr1) -> xpress::VariableBuilder::MapBuilder< K1 >
  Create a builder that will create a 1-dimensional map of columns or variables from the specified data.
 
template<typename Coll0 , typename Coll1 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type>
static auto  map2 (Coll0 const &coll1, Coll1 const &coll2) -> xpress::VariableBuilder::Map2Builder< K1, K2 >
  Create a builder that will create a 2-dimensional map of columns or variables from the specified data.
 
template<typename K1 , typename K2 >
static auto  map2 (xpress::SizedArray< K1 const > const &arr1, xpress::SizedArray< K2 const > const &arr2) -> xpress::VariableBuilder::Map2Builder< K1, K2 >
  Create a builder that will create a 2-dimensional map of columns or variables from the specified data.
 
template<typename Coll0 , typename Coll1 , typename Coll2 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename K3 = typename Coll2::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type, typename Coll2IsCollection = typename std::enable_if<xpress::is_collection<Coll2>::value>::type>
static auto  map3 (Coll0 const &coll1, Coll1 const &coll2, Coll2 const &coll3) -> xpress::VariableBuilder::Map3Builder< K1, K2, K3 >
  Create a builder that will create a 3-dimensional map of columns or variables from the specified data.
 
template<typename K1 , typename K2 , typename K3 >
static auto  map3 (xpress::SizedArray< K1 const > const &arr1, xpress::SizedArray< K2 const > const &arr2, xpress::SizedArray< K3 const > const &arr3) -> xpress::VariableBuilder::Map3Builder< K1, K2, K3 >
  Create a builder that will create a 3-dimensional map of columns or variables from the specified data.
 
template<typename Coll0 , typename Coll1 , typename Coll2 , typename Coll3 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename K3 = typename Coll2::value_type, typename K4 = typename Coll3::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type, typename Coll2IsCollection = typename std::enable_if<xpress::is_collection<Coll2>::value>::type, typename Coll3IsCollection = typename std::enable_if<xpress::is_collection<Coll3>::value>::type>
static auto  map4 (Coll0 const &coll1, Coll1 const &coll2, Coll2 const &coll3, Coll3 const &coll4) -> xpress::VariableBuilder::Map4Builder< K1, K2, K3, K4 >
  Create a builder that will create a 4-dimensional map of columns or variables from the specified data.
 
template<typename K1 , typename K2 , typename K3 , typename K4 >
static auto  map4 (xpress::SizedArray< K1 const > const &arr1, xpress::SizedArray< K2 const > const &arr2, xpress::SizedArray< K3 const > const &arr3, xpress::SizedArray< K4 const > const &arr4) -> xpress::VariableBuilder::Map4Builder< K1, K2, K3, K4 >
  Create a builder that will create a 4-dimensional map of columns or variables from the specified data.
 
template<typename Coll0 , typename Coll1 , typename Coll2 , typename Coll3 , typename Coll4 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename K3 = typename Coll2::value_type, typename K4 = typename Coll3::value_type, typename K5 = typename Coll4::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type, typename Coll2IsCollection = typename std::enable_if<xpress::is_collection<Coll2>::value>::type, typename Coll3IsCollection = typename std::enable_if<xpress::is_collection<Coll3>::value>::type, typename Coll4IsCollection = typename std::enable_if<xpress::is_collection<Coll4>::value>::type>
static auto  map5 (Coll0 const &coll1, Coll1 const &coll2, Coll2 const &coll3, Coll3 const &coll4, Coll4 const &coll5) -> xpress::VariableBuilder::Map5Builder< K1, K2, K3, K4, K5 >
  Create a builder that will create a 5-dimensional map of columns or variables from the specified data.
 
template<typename K1 , typename K2 , typename K3 , typename K4 , typename K5 >
static auto  map5 (xpress::SizedArray< K1 const > const &arr1, xpress::SizedArray< K2 const > const &arr2, xpress::SizedArray< K3 const > const &arr3, xpress::SizedArray< K4 const > const &arr4, xpress::SizedArray< K5 const > const &arr5) -> xpress::VariableBuilder::Map5Builder< K1, K2, K3, K4, K5 >
  Create a builder that will create a 5-dimensional map of columns or variables from the specified data.
 

Detailed Description

Builders for creating arrays or maps of variables.

Member Function Documentation

array()

static auto xpress::VariableBuilder::array ( int dim ) -> xpress::VariableBuilder::ArrayBuilder
inlinestatic

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

Parameters
dim Dimension.
Returns
The builder.
Since
44.00

array2()

static auto xpress::VariableBuilder::array2 ( int dim1,
int dim2 ) -> xpress::VariableBuilder::Array2Builder
inlinestatic

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

Parameters
dim1 Dimension 1.
dim2 Dimension 2.
Returns
The builder.
Since
44.00

array3()

static auto xpress::VariableBuilder::array3 ( int dim1,
int dim2,
int dim3 ) -> xpress::VariableBuilder::Array3Builder
inlinestatic

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

Parameters
dim1 Dimension 1.
dim2 Dimension 2.
dim3 Dimension 3.
Returns
The builder.
Since
44.00

array4()

static auto xpress::VariableBuilder::array4 ( int dim1,
int dim2,
int dim3,
int dim4 ) -> xpress::VariableBuilder::Array4Builder
inlinestatic

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

Parameters
dim1 Dimension 1.
dim2 Dimension 2.
dim3 Dimension 3.
dim4 Dimension 4.
Returns
The builder.
Since
44.00

array5()

static auto xpress::VariableBuilder::array5 ( int dim1,
int dim2,
int dim3,
int dim4,
int dim5 ) -> xpress::VariableBuilder::Array5Builder
inlinestatic

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

Parameters
dim1 Dimension 1.
dim2 Dimension 2.
dim3 Dimension 3.
dim4 Dimension 4.
dim5 Dimension 5.
Returns
The builder.
Since
44.00

map() [1/2]

template<typename Coll0 , typename K1 = typename Coll0::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type>
static auto xpress::VariableBuilder::map ( Coll0 const & coll1 ) -> xpress::VariableBuilder::MapBuilder< K1 >
inlinestatic

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

Parameters
coll1 Data for the builder.
Template Parameters
Coll0 Something that supports begin() and end() and contains values of type K1.
K1 Data type for dimension 1
Returns
The builder.
Since
44.00

map() [2/2]

template<typename K1 >
static auto xpress::VariableBuilder::map ( xpress::SizedArray< K1 const > const & arr1 ) -> xpress::VariableBuilder::MapBuilder< K1 >
inlinestatic

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

Parameters
arr1 Data for the builder.
Template Parameters
K1 Data type for dimension 1
Returns
The builder.
Since
44.00

map2() [1/2]

template<typename Coll0 , typename Coll1 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type>
static auto xpress::VariableBuilder::map2 ( Coll0 const & coll1,
Coll1 const & coll2 ) -> xpress::VariableBuilder::Map2Builder< K1, K2 >
inlinestatic

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

Parameters
coll1 Data for the builder.
coll2 Data for the builder.
Template Parameters
Coll0 Something that supports begin() and end() and contains values of type K1.
Coll1 Something that supports begin() and end() and contains values of type K2.
K1 Data type for dimension 1
K2 Data type for dimension 2
Returns
The builder.
Since
44.00

map2() [2/2]

template<typename K1 , typename K2 >
static auto xpress::VariableBuilder::map2 ( xpress::SizedArray< K1 const > const & arr1,
xpress::SizedArray< K2 const > const & arr2 ) -> xpress::VariableBuilder::Map2Builder< K1, K2 >
inlinestatic

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

Parameters
arr1 Data for the builder.
arr2 Data for the builder.
Template Parameters
K1 Data type for dimension 1
K2 Data type for dimension 2
Returns
The builder.
Since
44.00

map3() [1/2]

template<typename Coll0 , typename Coll1 , typename Coll2 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename K3 = typename Coll2::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type, typename Coll2IsCollection = typename std::enable_if<xpress::is_collection<Coll2>::value>::type>
static auto xpress::VariableBuilder::map3 ( Coll0 const & coll1,
Coll1 const & coll2,
Coll2 const & coll3 ) -> xpress::VariableBuilder::Map3Builder< K1, K2, K3 >
inlinestatic

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

Parameters
coll1 Data for the builder.
coll2 Data for the builder.
coll3 Data for the builder.
Template Parameters
Coll0 Something that supports begin() and end() and contains values of type K1.
Coll1 Something that supports begin() and end() and contains values of type K2.
Coll2 Something that supports begin() and end() and contains values of type K3.
K1 Data type for dimension 1
K2 Data type for dimension 2
K3 Data type for dimension 3
Returns
The builder.
Since
44.00

map3() [2/2]

template<typename K1 , typename K2 , typename K3 >
static auto xpress::VariableBuilder::map3 ( xpress::SizedArray< K1 const > const & arr1,
xpress::SizedArray< K2 const > const & arr2,
xpress::SizedArray< K3 const > const & arr3 ) -> xpress::VariableBuilder::Map3Builder< K1, K2, K3 >
inlinestatic

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

Parameters
arr1 Data for the builder.
arr2 Data for the builder.
arr3 Data for the builder.
Template Parameters
K1 Data type for dimension 1
K2 Data type for dimension 2
K3 Data type for dimension 3
Returns
The builder.
Since
44.00

map4() [1/2]

template<typename Coll0 , typename Coll1 , typename Coll2 , typename Coll3 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename K3 = typename Coll2::value_type, typename K4 = typename Coll3::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type, typename Coll2IsCollection = typename std::enable_if<xpress::is_collection<Coll2>::value>::type, typename Coll3IsCollection = typename std::enable_if<xpress::is_collection<Coll3>::value>::type>
static auto xpress::VariableBuilder::map4 ( Coll0 const & coll1,
Coll1 const & coll2,
Coll2 const & coll3,
Coll3 const & coll4 ) -> xpress::VariableBuilder::Map4Builder< K1, K2, K3, K4 >
inlinestatic

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

Parameters
coll1 Data for the builder.
coll2 Data for the builder.
coll3 Data for the builder.
coll4 Data for the builder.
Template Parameters
Coll0 Something that supports begin() and end() and contains values of type K1.
Coll1 Something that supports begin() and end() and contains values of type K2.
Coll2 Something that supports begin() and end() and contains values of type K3.
Coll3 Something that supports begin() and end() and contains values of type K4.
K1 Data type for dimension 1
K2 Data type for dimension 2
K3 Data type for dimension 3
K4 Data type for dimension 4
Returns
The builder.
Since
44.00

map4() [2/2]

template<typename K1 , typename K2 , typename K3 , typename K4 >
static auto xpress::VariableBuilder::map4 ( xpress::SizedArray< K1 const > const & arr1,
xpress::SizedArray< K2 const > const & arr2,
xpress::SizedArray< K3 const > const & arr3,
xpress::SizedArray< K4 const > const & arr4 ) -> xpress::VariableBuilder::Map4Builder< K1, K2, K3, K4 >
inlinestatic

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

Parameters
arr1 Data for the builder.
arr2 Data for the builder.
arr3 Data for the builder.
arr4 Data for the builder.
Template Parameters
K1 Data type for dimension 1
K2 Data type for dimension 2
K3 Data type for dimension 3
K4 Data type for dimension 4
Returns
The builder.
Since
44.00

map5() [1/2]

template<typename Coll0 , typename Coll1 , typename Coll2 , typename Coll3 , typename Coll4 , typename K1 = typename Coll0::value_type, typename K2 = typename Coll1::value_type, typename K3 = typename Coll2::value_type, typename K4 = typename Coll3::value_type, typename K5 = typename Coll4::value_type, typename Coll0IsCollection = typename std::enable_if<xpress::is_collection<Coll0>::value>::type, typename Coll1IsCollection = typename std::enable_if<xpress::is_collection<Coll1>::value>::type, typename Coll2IsCollection = typename std::enable_if<xpress::is_collection<Coll2>::value>::type, typename Coll3IsCollection = typename std::enable_if<xpress::is_collection<Coll3>::value>::type, typename Coll4IsCollection = typename std::enable_if<xpress::is_collection<Coll4>::value>::type>
static auto xpress::VariableBuilder::map5 ( Coll0 const & coll1,
Coll1 const & coll2,
Coll2 const & coll3,
Coll3 const & coll4,
Coll4 const & coll5 ) -> xpress::VariableBuilder::Map5Builder< K1, K2, K3, K4, K5 >
inlinestatic

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

Parameters
coll1 Data for the builder.
coll2 Data for the builder.
coll3 Data for the builder.
coll4 Data for the builder.
coll5 Data for the builder.
Template Parameters
Coll0 Something that supports begin() and end() and contains values of type K1.
Coll1 Something that supports begin() and end() and contains values of type K2.
Coll2 Something that supports begin() and end() and contains values of type K3.
Coll3 Something that supports begin() and end() and contains values of type K4.
Coll4 Something that supports begin() and end() and contains values of type K5.
K1 Data type for dimension 1
K2 Data type for dimension 2
K3 Data type for dimension 3
K4 Data type for dimension 4
K5 Data type for dimension 5
Returns
The builder.
Since
44.00

map5() [2/2]

template<typename K1 , typename K2 , typename K3 , typename K4 , typename K5 >
static auto xpress::VariableBuilder::map5 ( xpress::SizedArray< K1 const > const & arr1,
xpress::SizedArray< K2 const > const & arr2,
xpress::SizedArray< K3 const > const & arr3,
xpress::SizedArray< K4 const > const & arr4,
xpress::SizedArray< K5 const > const & arr5 ) -> xpress::VariableBuilder::Map5Builder< K1, K2, K3, K4, K5 >
inlinestatic

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

Parameters
arr1 Data for the builder.
arr2 Data for the builder.
arr3 Data for the builder.
arr4 Data for the builder.
arr5 Data for the builder.
Template Parameters
K1 Data type for dimension 1
K2 Data type for dimension 2
K3 Data type for dimension 3
K4 Data type for dimension 4
K5 Data type for dimension 5
Returns
The builder.
Since
44.00
The documentation for this class was generated from the following file:
  • xpress.hpp
Covered Topics
Parent Topic xpress

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