VariableBuilder

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

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
template<typename C , is-integral(C) >
static auto	array (C dim) -> xpress::VariableBuilder::ArrayBuilder< C >
	Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.

template<typename C1 , typename C2 , is-integral(C1) , is-integral(C2) >
static auto	array2 (C1 dim1, C2 dim2) -> xpress::VariableBuilder::Array2Builder< C1, C2 >
	Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.

template<typename C1 , typename C2 , typename C3 , is-integral(C1) , is-integral(C2) , is-integral(C3) >
static auto	array3 (C1 dim1, C2 dim2, C3 dim3) -> xpress::VariableBuilder::Array3Builder< C1, C2, C3 >
	Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.

template<typename C1 , typename C2 , typename C3 , typename C4 , is-integral(C1) , is-integral(C2) , is-integral(C3) , is-integral(C4) >
static auto	array4 (C1 dim1, C2 dim2, C3 dim3, C4 dim4) -> xpress::VariableBuilder::Array4Builder< C1, C2, C3, C4 >
	Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.

template<typename C1 , typename C2 , typename C3 , typename C4 , typename C5 , is-integral(C1) , is-integral(C2) , is-integral(C3) , is-integral(C4) , is-integral(C5) >
static auto	array5 (C1 dim1, C2 dim2, C3 dim3, C4 dim4, C5 dim5) -> xpress::VariableBuilder::Array5Builder< C1, C2, C3, C4, C5 >
	Create a builder that will create a multi-dimensional array of columns/variables with the specified dimensions.

template<typename Iter0 , typename K1 = element-type(Iter0), is-iterable(Iter0) >
static auto	map (Iter0 const &iterable1) -> 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 Iter0 , typename Iter1 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), is-iterable(Iter0) , is-iterable(Iter1) >
static auto	map2 (Iter0 const &iterable1, Iter1 const &iterable2) -> 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 Iter0 , typename Iter1 , typename Iter2 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), typename K3 = element-type(Iter2), is-iterable(Iter0) , is-iterable(Iter1) , is-iterable(Iter2) >
static auto	map3 (Iter0 const &iterable1, Iter1 const &iterable2, Iter2 const &iterable3) -> 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 Iter0 , typename Iter1 , typename Iter2 , typename Iter3 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), typename K3 = element-type(Iter2), typename K4 = element-type(Iter3), is-iterable(Iter0) , is-iterable(Iter1) , is-iterable(Iter2) , is-iterable(Iter3) >
static auto	map4 (Iter0 const &iterable1, Iter1 const &iterable2, Iter2 const &iterable3, Iter3 const &iterable4) -> 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 Iter0 , typename Iter1 , typename Iter2 , typename Iter3 , typename Iter4 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), typename K3 = element-type(Iter2), typename K4 = element-type(Iter3), typename K5 = element-type(Iter4), is-iterable(Iter0) , is-iterable(Iter1) , is-iterable(Iter2) , is-iterable(Iter3) , is-iterable(Iter4) >
static auto	map5 (Iter0 const &iterable1, Iter1 const &iterable2, Iter2 const &iterable3, Iter3 const &iterable4, Iter4 const &iterable5) -> 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.

Since: 44.00

Member Function Documentation

array()

template<typename C , is-integral(C) >

static auto xpress::VariableBuilder::array ( C dim ) -> xpress::VariableBuilder::ArrayBuilder< C >

inlinestatic

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

Parameters

dim	Dimension.

Template Parameters

C	Type for count.

Returns: The builder.

Since: 44.00

array2()

template<typename C1 , typename C2 , is-integral(C1) , is-integral(C2) >

static auto xpress::VariableBuilder::array2	(	C1	dim1,
		C2	dim2 ) -> xpress::VariableBuilder::Array2Builder< C1, C2 >

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.

Template Parameters

C1	Type for count of dimension 1.
C2	Type for count of dimension 2.

Returns: The builder.

Since: 44.00

array3()

template<typename C1 , typename C2 , typename C3 , is-integral(C1) , is-integral(C2) , is-integral(C3) >

static auto xpress::VariableBuilder::array3	(	C1	dim1,
		C2	dim2,
		C3	dim3 ) -> xpress::VariableBuilder::Array3Builder< C1, C2, C3 >

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.

Template Parameters

C1	Type for count of dimension 1.
C2	Type for count of dimension 2.
C3	Type for count of dimension 3.

Returns: The builder.

Since: 44.00

array4()

template<typename C1 , typename C2 , typename C3 , typename C4 , is-integral(C1) , is-integral(C2) , is-integral(C3) , is-integral(C4) >

static auto xpress::VariableBuilder::array4	(	C1	dim1,
		C2	dim2,
		C3	dim3,
		C4	dim4 ) -> xpress::VariableBuilder::Array4Builder< C1, C2, C3, C4 >

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.

Template Parameters

C1	Type for count of dimension 1.
C2	Type for count of dimension 2.
C3	Type for count of dimension 3.
C4	Type for count of dimension 4.

Returns: The builder.

Since: 44.00

array5()

template<typename C1 , typename C2 , typename C3 , typename C4 , typename C5 , is-integral(C1) , is-integral(C2) , is-integral(C3) , is-integral(C4) , is-integral(C5) >

static auto xpress::VariableBuilder::array5	(	C1	dim1,
		C2	dim2,
		C3	dim3,
		C4	dim4,
		C5	dim5 ) -> xpress::VariableBuilder::Array5Builder< C1, C2, C3, C4, C5 >

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.

Template Parameters

C1	Type for count of dimension 1.
C2	Type for count of dimension 2.
C3	Type for count of dimension 3.
C4	Type for count of dimension 4.
C5	Type for count of dimension 5.

Returns: The builder.

Since: 44.00

map() [1/2]

template<typename Iter0 , typename K1 = element-type(Iter0), is-iterable(Iter0) >

static auto xpress::VariableBuilder::map ( Iter0 const & iterable1 ) -> xpress::VariableBuilder::MapBuilder< K1 >

inlinestatic

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

Parameters

iterable1 Data for the builder.

Template Parameters

Iter0	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 Iter0 , typename Iter1 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), is-iterable(Iter0) , is-iterable(Iter1) >

static auto xpress::VariableBuilder::map2	(	Iter0 const &	iterable1,
		Iter1 const &	iterable2 ) -> 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

iterable1	Data for the builder.
iterable2	Data for the builder.

Template Parameters

Iter0	Something that supports `begin()` and `end()` and contains values of type `K1`.
Iter1	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 Iter0 , typename Iter1 , typename Iter2 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), typename K3 = element-type(Iter2), is-iterable(Iter0) , is-iterable(Iter1) , is-iterable(Iter2) >

static auto xpress::VariableBuilder::map3	(	Iter0 const &	iterable1,
		Iter1 const &	iterable2,
		Iter2 const &	iterable3 ) -> 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

iterable1	Data for the builder.
iterable2	Data for the builder.
iterable3	Data for the builder.

Template Parameters

Iter0	Something that supports `begin()` and `end()` and contains values of type `K1`.
Iter1	Something that supports `begin()` and `end()` and contains values of type `K2`.
Iter2	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 Iter0 , typename Iter1 , typename Iter2 , typename Iter3 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), typename K3 = element-type(Iter2), typename K4 = element-type(Iter3), is-iterable(Iter0) , is-iterable(Iter1) , is-iterable(Iter2) , is-iterable(Iter3) >

static auto xpress::VariableBuilder::map4	(	Iter0 const &	iterable1,
		Iter1 const &	iterable2,
		Iter2 const &	iterable3,
		Iter3 const &	iterable4 ) -> 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

iterable1	Data for the builder.
iterable2	Data for the builder.
iterable3	Data for the builder.
iterable4	Data for the builder.

Template Parameters

Iter0	Something that supports `begin()` and `end()` and contains values of type `K1`.
Iter1	Something that supports `begin()` and `end()` and contains values of type `K2`.
Iter2	Something that supports `begin()` and `end()` and contains values of type `K3`.
Iter3	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 Iter0 , typename Iter1 , typename Iter2 , typename Iter3 , typename Iter4 , typename K1 = element-type(Iter0), typename K2 = element-type(Iter1), typename K3 = element-type(Iter2), typename K4 = element-type(Iter3), typename K5 = element-type(Iter4), is-iterable(Iter0) , is-iterable(Iter1) , is-iterable(Iter2) , is-iterable(Iter3) , is-iterable(Iter4) >

static auto xpress::VariableBuilder::map5	(	Iter0 const &	iterable1,
		Iter1 const &	iterable2,
		Iter2 const &	iterable3,
		Iter3 const &	iterable4,
		Iter4 const &	iterable5 ) -> 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

iterable1	Data for the builder.
iterable2	Data for the builder.
iterable3	Data for the builder.
iterable4	Data for the builder.
iterable5	Data for the builder.

Template Parameters

Iter0	Something that supports `begin()` and `end()` and contains values of type `K1`.
Iter1	Something that supports `begin()` and `end()` and contains values of type `K2`.
Iter2	Something that supports `begin()` and `end()` and contains values of type `K3`.
Iter3	Something that supports `begin()` and `end()` and contains values of type `K4`.
Iter4	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

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

Contents

Index

Glossary

Search Results

VariableBuilder

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

array()

array2()

array3()

array4()

array5()

map() [1/2]

map() [2/2]

map2() [1/2]

map2() [2/2]

map3() [1/2]

map3() [2/2]

map4() [1/2]

map4() [2/2]

map5() [1/2]

map5() [2/2]