Generated on Tue Mar 24 2020 14:04:04 for Gecode by doxygen 1.8.17
Related Functions | List of all members
Gecode::VarArgArray< Var > Class Template Reference
Functionality by programming task » Programming variables

Argument array for variables. More...

#include <array.hpp>

Related Functions

(Note that these are not member functions.)

template<class Var >
bool same (VarArgArray< Var > x, VarArgArray< Var > y)
 Test whether array x together with array y contains at least one variable being the same. More...
 
template<class Var >
bool same (VarArgArray< Var > x, Var y)
 Test whether array x contains variable y. More...
 
template<class Var >
bool same (Var x, VarArgArray< Var > y)
 Test whether array y contains variable x. More...
 
template<class Var >
bool same (VarArgArray< Var > x)
 Test whether array x contains a variable multiply. More...
 

Constructors and initialization

 VarArgArray (void)
 Allocate empty array. More...
 
 VarArgArray (int n)
 Allocate array with n elements. More...
 
 VarArgArray (const VarArgArray< Var > &a)
 Initialize from variable argument array a (copy elements) More...
 
 VarArgArray (const VarArray< Var > &a)
 Initialize from variable array a (copy elements) More...
 
 VarArgArray (const std::vector< Var > &a)
 Initialize from vector a. More...
 
 VarArgArray (std::initializer_list< Var > a)
 Initialize from initializer list a. More...
 
template<class InputIterator >
 VarArgArray (InputIterator first, InputIterator last)
 Initialize from InputIterator first and last. More...
 

Array elements

ArrayTraits< VarArgArray< Var > >::ArgsType slice (int start, int inc=1, int n=-1)
 Return slice $y$ of length n such that forall $0\leq i<n$, $y_i=x_{\text{start}+i\cdot\text{inc}}$. More...
 

Appending elements

ArrayTraits< VarArgArray< Var > >::ArgsType & operator<< (const Var &x)
 Insert a new element x at the end of the array (increase size by 1) More...
 
ArrayTraits< VarArgArray< Var > >::ArgsType & operator<< (const VarArgArray< Var > &x)
 Append x to the end of the array. More...
 
bool assigned (void) const
 Test if all variables are assigned. More...
 

Detailed Description

template<class Var>
class Gecode::VarArgArray< Var >

Argument array for variables.

Argument arrays are used as convenient mechanism of passing arguments when calling functions as they combine both the size and the elements of an array. For a small number of elements, memory is allocated by creating an argument array object. Otherwise the memory is allocated from the heap.

Definition at line 79 of file array.hpp.

Constructor & Destructor Documentation

◆ VarArgArray() [1/7]

template<class Var >
Gecode::VarArgArray< Var >::VarArgArray ( void  )
inline

Allocate empty array.

Definition at line 1839 of file array.hpp.

◆ VarArgArray() [2/7]

template<class Var >
Gecode::VarArgArray< Var >::VarArgArray ( int  n)
inlineexplicit

Allocate array with n elements.

Definition at line 1843 of file array.hpp.

◆ VarArgArray() [3/7]

template<class Var >
Gecode::VarArgArray< Var >::VarArgArray ( const VarArgArray< Var > &  a)
inline

Initialize from variable argument array a (copy elements)

Definition at line 1847 of file array.hpp.

◆ VarArgArray() [4/7]

template<class Var >
Gecode::VarArgArray< Var >::VarArgArray ( const VarArray< Var > &  a)
inline

Initialize from variable array a (copy elements)

Definition at line 1868 of file array.hpp.

◆ VarArgArray() [5/7]

template<class Var >
Gecode::VarArgArray< Var >::VarArgArray ( const std::vector< Var > &  a)
inline

Initialize from vector a.

Definition at line 1852 of file array.hpp.

◆ VarArgArray() [6/7]

template<class Var >
Gecode::VarArgArray< Var >::VarArgArray ( std::initializer_list< Var >  a)
inline

Initialize from initializer list a.

Definition at line 1857 of file array.hpp.

◆ VarArgArray() [7/7]

template<class Var >
template<class InputIterator >
Gecode::VarArgArray< Var >::VarArgArray ( InputIterator  first,
InputIterator  last 
)
inline

Initialize from InputIterator first and last.

Definition at line 1863 of file array.hpp.

Member Function Documentation

◆ slice()

template<class Var >
ArrayTraits< VarArgArray< Var > >::ArgsType Gecode::VarArgArray< Var >::slice ( int  start,
int  inc = 1,
int  n = -1 
)
inline

Return slice $y$ of length n such that forall $0\leq i<n$, $y_i=x_{\text{start}+i\cdot\text{inc}}$.

Definition at line 1876 of file array.hpp.

◆ operator<<() [1/2]

template<class Var >
ArrayTraits< VarArgArray< Var > >::ArgsType & Gecode::VarArgArray< Var >::operator<< ( const Var &  x)
inline

Insert a new element x at the end of the array (increase size by 1)

Definition at line 1884 of file array.hpp.

◆ operator<<() [2/2]

template<class Var >
ArrayTraits< VarArgArray< Var > >::ArgsType & Gecode::VarArgArray< Var >::operator<< ( const VarArgArray< Var > &  x)
inline

Append x to the end of the array.

Definition at line 1892 of file array.hpp.

◆ assigned()

template<class Var >
bool Gecode::VarArgArray< Var >::assigned ( void  ) const
inline

Test if all variables are assigned.

Definition at line 1923 of file array.hpp.

Friends And Related Function Documentation

◆ same() [1/4]

template<class Var >
bool same ( VarArgArray< Var >  x,
VarArgArray< Var >  y 
)
related

Test whether array x together with array y contains at least one variable being the same.

Note that assigned variables are ignored.

Definition at line 1937 of file array.hpp.

◆ same() [2/4]

template<class Var >
bool same ( VarArgArray< Var >  x,
Var  y 
)
related

Test whether array x contains variable y.

Note that assigned variables are ignored.

Definition at line 1960 of file array.hpp.

◆ same() [3/4]

template<class Var >
bool same ( Var  x,
VarArgArray< Var >  y 
)
related

Test whether array y contains variable x.

Note that assigned variables are ignored.

Definition at line 1971 of file array.hpp.

◆ same() [4/4]

template<class Var >
bool same ( VarArgArray< Var >  x)
related

Test whether array x contains a variable multiply.

Note that assigned variables are ignored.

Definition at line 1977 of file array.hpp.

The documentation for this class was generated from the following file: