Generated on Wed Jan 4 17:49:18 2006 for Gecode by doxygen 1.4.6

Gecode::VarArray< Var > Class Template Reference
[Programming variables]

List of all members.

Detailed Description

template<class Var>
class Gecode::VarArray< Var >

Variable arrays

Variable arrays store variables. They are typically used for storing the variables being part of a solution.

Never use them for temporary purposes, use argument arrays instead.

Definition at line 43 of file array.icc.

Constructors and initialization

 VarArray (void)
 Default constructor (array of size 0).
 VarArray (Space *, int m)
 Allocate array with m variables.
 VarArray (Space *, const VarArgArray< Var > &)
 Initialize from variable argument array a (copy elements).
 VarArray (const VarArray< Var > &a)
 Initialize from variable array a (share elements).
const VarArray< Var > & operator= (const VarArray< Var > &a)
 Initialize from variable array a (share elements).

Array size

int size (void) const
 Return size of array (number of elements).

Array elements

Var & operator[] (int i)
 Return variable at position i.
const Var & operator[] (int i) const
 Return variable at position i.

Cloning

void update (Space *, bool share, VarArray< Var > &a)
 Update array to be a clone of array a.

Protected Attributes

int n
 Number of variables (size).
Var * x
 Array of variables.


Constructor & Destructor Documentation

template<class Var>
Gecode::VarArray< Var >::VarArray void   )  [inline]
 

Default constructor (array of size 0).

Definition at line 397 of file array.icc.

template<class Var>
Gecode::VarArray< Var >::VarArray Space ,
int  m
[inline]
 

Allocate array with m variables.

Definition at line 401 of file array.icc.

template<class Var>
Gecode::VarArray< Var >::VarArray Space ,
const VarArgArray< Var > & 
[inline]
 

Initialize from variable argument array a (copy elements).

Definition at line 868 of file array.icc.

template<class Var>
Gecode::VarArray< Var >::VarArray const VarArray< Var > &  a  )  [inline]
 

Initialize from variable array a (share elements).

Definition at line 408 of file array.icc.


Member Function Documentation

template<class Var>
const VarArray< Var > & Gecode::VarArray< Var >::operator= const VarArray< Var > &  a  )  [inline]
 

Initialize from variable array a (share elements).

Definition at line 414 of file array.icc.

template<class Var>
int Gecode::VarArray< Var >::size void   )  const [inline]
 

Return size of array (number of elements).

Definition at line 421 of file array.icc.

template<class Var>
Var & Gecode::VarArray< Var >::operator[] int  i  )  [inline]
 

Return variable at position i.

Reimplemented in Gecode::BoolVarArray.

Definition at line 427 of file array.icc.

template<class Var>
const Var & Gecode::VarArray< Var >::operator[] int  i  )  const [inline]
 

Return variable at position i.

Reimplemented in Gecode::BoolVarArray.

Definition at line 434 of file array.icc.

template<class Var>
void Gecode::VarArray< Var >::update Space ,
bool  share,
VarArray< Var > &  a
[inline]
 

Update array to be a clone of array a.

If share is true, sharing is retained for all shared data structures. Otherwise, for each of them an independent copy is created.

Definition at line 441 of file array.icc.


Member Data Documentation

template<class Var>
int Gecode::VarArray< Var >::n [protected]
 

Number of variables (size).

Definition at line 46 of file array.icc.

template<class Var>
Var* Gecode::VarArray< Var >::x [protected]
 

Array of variables.

Definition at line 48 of file array.icc.


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