Generated on Mon Sep 17 2012 22:20:52 for Gecode by doxygen 1.8.1.1
Gecode::ArgArray< T > Class Template Reference

Argument array for non-primitive types. More...

#include <array.hpp>

List of all members.

Friends

ArrayTraits< ArgArray< T >
>::ArgsType 
operator+ (const ArgArray< T > &x, const ArgArray< T > &y)
ArrayTraits< ArgArray< T >
>::ArgsType 
operator+ (const ArgArray< T > &x, const T &y)
ArrayTraits< ArgArray< T >
>::ArgsType 
operator+ (const T &x, const ArgArray< T > &y)

Related Functions

(Note that these are not member functions.)

template<class T >
ArrayTraits< ArgArray< T >
>::ArgsType 
operator+ (const ArgArray< T > &x, const ArgArray< T > &y)
template<class T >
ArrayTraits< ArgArray< T >
>::ArgsType 
operator+ (const ArgArray< T > &x, const T &y)
template<class T >
ArrayTraits< ArgArray< T >
>::ArgsType 
operator+ (const T &x, const ArgArray< T > &y)
template<class Var >
ArrayTraits< VarArgArray< Var >
>::ArgsType 
operator+ (const VarArgArray< Var > &x, const VarArgArray< Var > &y)
template<class Var >
ArrayTraits< VarArgArray< Var >
>::ArgsType 
operator+ (const VarArgArray< Var > &x, const Var &y)
template<class Var >
ArrayTraits< VarArgArray< Var >
>::ArgsType 
operator+ (const Var &x, const VarArgArray< Var > &y)
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const ArgArrayBase< T > &x)

Constructors and initialization

 ArgArray (void)
 Allocate empty array.
 ArgArray (int n)
 Allocate array with n elements.
 ArgArray (int n, const T *e)
 Allocate array with n elements and initialize with elements from array e.
 ArgArray (const ArgArray< T > &a)
 Initialize from primitive argument array a (copy elements)

Array elements

ArrayTraits< ArgArray< T >
>::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< ArgArray< T >
>::ArgsType & 
operator<< (const T &x)
 Insert a new element x at the end of the array (increase size by 1)
ArrayTraits< ArgArray< T >
>::ArgsType & 
operator<< (const ArgArray< T > &x)
 Append x to the end of the array.

Additional Inherited Members

- Public Types inherited from Gecode::ArgArrayBase< T >
typedef T value_type
 Type of the view stored in this array.
typedef T & reference
 Type of a reference to the value type.
typedef const T & const_reference
 Type of a constant reference to the value type.
typedef T * pointer
 Type of a pointer to the value type.
typedef const T * const_pointer
 Type of a read-only pointer to the value type.
typedef T * iterator
 Type of the iterator used to iterate through this array's elements.
typedef const T * const_iterator
 Type of the iterator used to iterate read-only through this array's elements.
typedef std::reverse_iterator
< T * > 
reverse_iterator
 Type of the iterator used to iterate backwards through this array's elements.
typedef std::reverse_iterator
< const T * > 
const_reverse_iterator
 Type of the iterator used to iterate backwards and read-only through this array's elements.
- Public Member Functions inherited from Gecode::ArgArrayBase< T >
 ArgArrayBase (void)
 Allocate empty array.
 ArgArrayBase (int n)
 Allocate array with n elements.
 ArgArrayBase (const ArgArrayBase< T > &a)
 Initialize from argument array a (copy elements)
const ArgArrayBase< T > & operator= (const ArgArrayBase< T > &a)
 Initialize from view array a (copy elements)
int size (void) const
 Return size of array (number of elements)
T & operator[] (int i)
 Return element at position i.
const T & operator[] (int i) const
 Return element at position i.
iterator begin (void)
 Return an iterator at the beginning of the array.
const_iterator begin (void) const
 Return a read-only iterator at the beginning of the array.
iterator end (void)
 Return an iterator past the end of the array.
const_iterator end (void) const
 Return a read-only iterator past the end of the array.
reverse_iterator rbegin (void)
 Return a reverse iterator at the end of the array.
const_reverse_iterator rbegin (void) const
 Return a reverse and read-only iterator at the end of the array.
reverse_iterator rend (void)
 Return a reverse iterator past the beginning of the array.
const_reverse_iterator rend (void) const
 Return a reverse and read-only iterator past the beginning of the array.
 ~ArgArrayBase (void)
 Destructor.
- Protected Member Functions inherited from Gecode::ArgArrayBase< T >
T * allocate (int n)
 Allocate memory for n elements.
void resize (int i)
 Resize to hold at least i additional elements.
template<class A >
concat (const ArgArrayBase< T > &x) const
 Return this array concatenated with x.
template<class A >
concat (const T &x) const
 Return this array concatenated with x.
template<class A >
A & append (const T &x)
 Insert a new element x at the end of the array (increase size by 1)
template<class A >
A & append (const ArgArrayBase< T > &x)
 Append x to the end of the array.
- Protected Attributes inherited from Gecode::ArgArrayBase< T >
int n
 Number of elements.
int capacity
 Allocated size of the array.
T * a
 Element array.
onstack [onstack_size]
 In-array storage for elements.
- Static Protected Attributes inherited from Gecode::ArgArrayBase< T >
static const int onstack_size = 16
 How many elements are possible inside array.

Detailed Description

template<class T>
class Gecode::ArgArray< T >

Argument array for non-primitive types.

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 751 of file array.hpp.


Constructor & Destructor Documentation

template<class T >
Gecode::ArgArray< T >::ArgArray ( void  )
inline

Allocate empty array.

Definition at line 1848 of file array.hpp.

template<class T >
Gecode::ArgArray< T >::ArgArray ( int  n)
inlineexplicit

Allocate array with n elements.

Definition at line 1852 of file array.hpp.

template<class T>
Gecode::ArgArray< T >::ArgArray ( int  n,
const T *  e 
)

Allocate array with n elements and initialize with elements from array e.

Definition at line 1855 of file array.hpp.

template<class T>
Gecode::ArgArray< T >::ArgArray ( const ArgArray< T > &  a)
inline

Initialize from primitive argument array a (copy elements)

Definition at line 1863 of file array.hpp.


Member Function Documentation

template<class T >
ArrayTraits< ArgArray< T > >::ArgsType Gecode::ArgArray< T >::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< T >.

Definition at line 1868 of file array.hpp.

template<class T>
ArrayTraits< ArgArray< T > >::ArgsType & Gecode::ArgArray< T >::operator<< ( const T &  x)
inline

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

Definition at line 1876 of file array.hpp.

template<class T>
ArrayTraits< ArgArray< T > >::ArgsType & Gecode::ArgArray< T >::operator<< ( const ArgArray< T > &  x)
inline

Append x to the end of the array.

Definition at line 1884 of file array.hpp.


Friends And Related Function Documentation

template<class T>
ArrayTraits<ArgArray<T> >::ArgsType operator+ ( const ArgArray< T > &  x,
const ArgArray< T > &  y 
)
friend

Definition at line 1892 of file array.hpp.

template<class T>
ArrayTraits<ArgArray<T> >::ArgsType operator+ ( const ArgArray< T > &  x,
const T &  y 
)
friend

Definition at line 1899 of file array.hpp.

template<class T>
ArrayTraits<ArgArray<T> >::ArgsType operator+ ( const T &  x,
const ArgArray< T > &  y 
)
friend

Definition at line 1906 of file array.hpp.

template<class T >
ArrayTraits< ArgArray< T > >::ArgsType operator+ ( const ArgArray< T > &  x,
const ArgArray< T > &  y 
)
related

Concatenate x and y and return result

Definition at line 1892 of file array.hpp.

template<class T >
ArrayTraits< ArgArray< T > >::ArgsType operator+ ( const ArgArray< T > &  x,
const T &  y 
)
related

Concatenate x and y and return result

Definition at line 1899 of file array.hpp.

template<class T >
ArrayTraits< ArgArray< T > >::ArgsType operator+ ( const T &  x,
const ArgArray< T > &  y 
)
related

Concatenate x and y and return result

Definition at line 1906 of file array.hpp.

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

Concatenate x and y and return result

Definition at line 1965 of file array.hpp.

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

Concatenate x and y and return result

Definition at line 1972 of file array.hpp.

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

Concatenate x and y and return result

Definition at line 1979 of file array.hpp.


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