Generated on Sat Aug 25 2012 15:53:09 for Gecode by doxygen 1.7.5
Gecode::VarArgArray Class Reference

Argument array for variables. More...

#include <array.hpp>

List of all members.

Classes

class  VarLess
 Sort order for variables. More...

Public Member Functions

bool assigned (void) const
 Test if all variables are assigned.

Friends

ArrayTraits< VarArgArray< Var >
>::ArgsType 
operator+ (const VarArgArray< Var > &x, const VarArgArray< Var > &y)
ArrayTraits< VarArgArray< Var >
>::ArgsType 
operator+ (const VarArgArray< Var > &x, const Var &y)
ArrayTraits< VarArgArray< Var >
>::ArgsType 
operator+ (const Var &x, const VarArgArray< Var > &y)

Constructors and initialization

 VarArgArray (void)
 Allocate empty array.
 VarArgArray (int n)
 Allocate array with n elements.
 VarArgArray (const VarArgArray< Var > &a)
 Initialize from variable argument array a (copy elements)
 VarArgArray (const VarArray< Var > &a)
 Initialize from variable array a (copy elements)

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}}$.

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)
ArrayTraits< VarArgArray< Var >
>::ArgsType & 
operator<< (const VarArgArray< Var > &x)
 Append x to the end of the array.

Variable equality

bool same (const Space &home) const
 Test whether array contains same variable multiply.
bool same (const Space &home, const Var &y) const
 Test whether array contains variable y.
bool same (const Space &home, const VarArgArray< Var > &y) const
 Test whether all elements from array and y contains same variable multiply.

Detailed Description

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.


Constructor & Destructor Documentation

Gecode::VarArgArray::VarArgArray ( void  ) [inline]

Allocate empty array.

Definition at line 1920 of file array.hpp.

Gecode::VarArgArray::VarArgArray ( int  n) [inline, explicit]

Allocate array with n elements.

Definition at line 1924 of file array.hpp.

Gecode::VarArgArray::VarArgArray ( const VarArgArray< Var > &  a) [inline]

Initialize from variable argument array a (copy elements)

Definition at line 1928 of file array.hpp.

Gecode::VarArgArray::VarArgArray ( const VarArray< Var > &  a) [inline]

Initialize from variable array a (copy elements)

Definition at line 1933 of file array.hpp.


Member Function Documentation

ArrayTraits< VarArgArray< Var > >::ArgsType Gecode::VarArgArray::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}}$.

Reimplemented from Gecode::ArgArrayBase< Var >.

Definition at line 1941 of file array.hpp.

ArrayTraits< VarArgArray< Var > >::ArgsType & Gecode::VarArgArray::operator<< ( const Var x) [inline]

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

Definition at line 1949 of file array.hpp.

ArrayTraits< VarArgArray< Var > >::ArgsType & Gecode::VarArgArray::operator<< ( const VarArgArray< Var > &  x) [inline]

Append x to the end of the array.

Definition at line 1957 of file array.hpp.

bool Gecode::VarArgArray::assigned ( void  ) const [inline]

Test if all variables are assigned.

Definition at line 1994 of file array.hpp.

bool Gecode::VarArgArray::same ( const Space home) const

Test whether array contains same variable multiply.

Note that assigned variables are ignored.

Definition at line 2003 of file array.hpp.

bool Gecode::VarArgArray::same ( const Space home,
const Var y 
) const

Test whether array contains variable y.

Note that assigned variables are ignored.

Definition at line 2046 of file array.hpp.

bool Gecode::VarArgArray::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 2023 of file array.hpp.


Friends And Related Function Documentation

ArrayTraits<VarArgArray<Var> >::ArgsType operator+ ( const VarArgArray< Var > &  x,
const VarArgArray< Var > &  y 
) [friend]

Definition at line 1965 of file array.hpp.

ArrayTraits<VarArgArray<Var> >::ArgsType operator+ ( const VarArgArray< Var > &  x,
const Var y 
) [friend]

Definition at line 1972 of file array.hpp.

ArrayTraits<VarArgArray<Var> >::ArgsType operator+ ( const Var x,
const VarArgArray< Var > &  y 
) [friend]

Definition at line 1979 of file array.hpp.


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