Generated on Tue Jan 28 2020 00:00:00 for Gecode by doxygen 1.8.17
Gecode::VarArgArray< Var > Class Template Reference

Argument array for variables. More...

#include <array.hpp>

Classes

class  VarLess
 Sort order for variables. 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...
 
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...
 

Variable equality

bool same (const Space &home) const
 Test whether array contains same variable multiply. More...
 
bool same (const Space &home, const Var &y) const
 Test whether array contains variable y. More...
 
bool same (const Space &home, const VarArgArray< Var > &y) const
 Test whether all elements from array and y contains same variable multiply. 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 53 of file array.hpp.

Constructor & Destructor Documentation

◆ VarArgArray() [1/6]

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

Allocate empty array.

Definition at line 1987 of file array.hpp.

◆ VarArgArray() [2/6]

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

Allocate array with n elements.

Definition at line 1991 of file array.hpp.

◆ VarArgArray() [3/6]

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

Initialize from variable argument array a (copy elements)

Definition at line 1995 of file array.hpp.

◆ VarArgArray() [4/6]

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

Initialize from variable array a (copy elements)

Definition at line 2011 of file array.hpp.

◆ VarArgArray() [5/6]

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

Initialize from vector a.

Definition at line 2000 of file array.hpp.

◆ VarArgArray() [6/6]

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

Initialize from InputIterator first and last.

Definition at line 2006 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 2019 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 2027 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 2035 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 2072 of file array.hpp.

◆ same() [1/3]

template<class Var >
bool Gecode::VarArgArray< Var >::same ( const Space home) const

Test whether array contains same variable multiply.

Note that assigned variables are ignored.

Definition at line 2081 of file array.hpp.

◆ same() [2/3]

template<class Var >
bool Gecode::VarArgArray< Var >::same ( const Space home,
const Var y 
) const

Test whether array contains variable y.

Note that assigned variables are ignored.

Definition at line 2124 of file array.hpp.

◆ same() [3/3]

template<class Var >
bool Gecode::VarArgArray< Var >::same ( const Space home,
const VarArgArray< Var > &  y 
) const

Test whether all elements from array and y contains same variable multiply.

Note that assigned variables are ignored.

Definition at line 2101 of file array.hpp.


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