Generated on Sat Nov 11 01:12:19 2006 for Gecode by doxygen 1.5.1

Gecode::ViewArray< View > Class Template Reference
[Programming actors]

List of all members.

Detailed Description

template<class View>
class Gecode::ViewArray< View >

View arrays.

View arrays store views. They are typically used for storing the views with which propagators and branchings compute.

Definition at line 103 of file array.icc.

Constructors and initialization

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

Array size

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

Array elements

View & operator[] (int i)
 Return view at position i.
const View & operator[] (int i) const
 Return view at position i.

Dependencies

void subscribe (Space *home, Propagator *p, PropCond pc, bool process=true)
 Subscribe propagator p with propagation condition pc to variable.
void cancel (Space *home, Propagator *p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to all views.

Cloning

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

Moving elements

void move_fst (int i)
 Move assigned view from position 0 to position i (shift elements to the left).
void move_lst (int i)
 Move assigned view from position size()-1 to position i (truncate array by one).
void move_fst (int i, Space *home, Propagator *p, PropCond pc)
 Move view from position 0 to position i (shift elements to the left).
void move_lst (int i, Space *home, Propagator *p, PropCond pc)
 Move view from position size()-1 to position i (truncate array by one).

Dropping elements

void drop_fst (int i)
 Drop assigned views from positions 0 to i-1 from array.
void drop_lst (int i)
 Drop assigned views from positions i+1 to size()-1 from array.
void drop_fst (int i, Space *home, Propagator *p, PropCond pc)
 Drop views from positions 0 to i-1 from array.
void drop_lst (int i, Space *home, Propagator *p, PropCond pc)
 Drop assigned views from positions i+1 to size()-1 from array.

View equality

bool same (void) const
 Test whether array has same views.
bool same (const View &y) const
 Test whether array contains a view being the same as y.
void unique (void)
 Remove all duplicate views from array (changes element order).

View sharing

bool shared (void) const
 Test whether array has shared views.
bool shared (const View &y) const
 Test whether array contains view shared with y.


Constructor & Destructor Documentation

template<class View>
Gecode::ViewArray< View >::ViewArray ( void   )  [inline]

Default constructor (array of size 0).

Definition at line 491 of file array.icc.

template<class View>
Gecode::ViewArray< View >::ViewArray ( Space ,
int  m 
) [inline]

Allocate array with m variables.

Definition at line 495 of file array.icc.

template<class View>
Gecode::ViewArray< View >::ViewArray ( const ViewArray< View > &  a  )  [inline]

Initialize from view array a (share elements).

Definition at line 514 of file array.icc.

template<class View>
Gecode::ViewArray< View >::ViewArray ( Space ,
const ViewArray< View > &  a 
)

Initialize from view array a (copy elements).

Definition at line 501 of file array.icc.

template<class View>
template<class Var>
Gecode::ViewArray< View >::ViewArray ( Space home,
const VarArgArray< Var > &  a 
) [inline]

Initialize from variable argument array a (copy elements).

Note that the view type View must provide a constructor for the associated Var type.

Definition at line 136 of file array.icc.


Member Function Documentation

template<class View>
const ViewArray< View > & Gecode::ViewArray< View >::operator= ( const ViewArray< View > &  a  )  [inline]

Initialize from view array a (share elements).

Definition at line 519 of file array.icc.

template<class View>
int Gecode::ViewArray< View >::size ( void   )  const [inline]

Return size of array (number of elements).

Definition at line 526 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::size ( int  n  )  [inline]

Decrease size of array (number of elements).

Definition at line 532 of file array.icc.

template<class View>
View & Gecode::ViewArray< View >::operator[] ( int  i  )  [inline]

Return view at position i.

Definition at line 538 of file array.icc.

template<class View>
const View & Gecode::ViewArray< View >::operator[] ( int  i  )  const [inline]

Return view at position i.

Definition at line 545 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::subscribe ( Space home,
Propagator p,
PropCond  pc,
bool  process = true 
)

Subscribe propagator p with propagation condition pc to variable.

In case process is false, the propagator is just subscribed but not processed for execution (this must be used when creating subscriptions during propagation).

Definition at line 633 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::cancel ( Space home,
Propagator p,
PropCond  pc 
)

Cancel subscription of propagator p with propagation condition pc to all views.

Definition at line 641 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::update ( Space ,
bool  share,
ViewArray< View > &  a 
)

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 620 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::move_fst ( int  i  )  [inline]

Move assigned view from position 0 to position i (shift elements to the left).

Definition at line 552 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::move_lst ( int  i  )  [inline]

Move assigned view from position size()-1 to position i (truncate array by one).

Definition at line 560 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::move_fst ( int  i,
Space home,
Propagator p,
PropCond  pc 
) [inline]

Move view from position 0 to position i (shift elements to the left).

Before moving, cancel subscription of propagator p with propagation condition pc to view at position i.

Definition at line 584 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::move_lst ( int  i,
Space home,
Propagator p,
PropCond  pc 
) [inline]

Move view from position size()-1 to position i (truncate array by one).

Before moving, cancel subscription of propagator p with propagation condition pc to view at position i.

Definition at line 592 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::drop_fst ( int  i  )  [inline]

Drop assigned views from positions 0 to i-1 from array.

Definition at line 568 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::drop_lst ( int  i  )  [inline]

Drop assigned views from positions i+1 to size()-1 from array.

Definition at line 576 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::drop_fst ( int  i,
Space home,
Propagator p,
PropCond  pc 
)

Drop views from positions 0 to i-1 from array.

Before moving, cancel subscription of propagator p with propagation condition pc to views at positions 0 to i-1.

Definition at line 600 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::drop_lst ( int  i,
Space home,
Propagator p,
PropCond  pc 
)

Drop assigned views from positions i+1 to size()-1 from array.

Before moving, cancel subscription of propagator p with propagation condition pc to views at positions i+1 to size()-1.

Definition at line 610 of file array.icc.

template<class View>
bool Gecode::ViewArray< View >::same ( void   )  const

Test whether array has same views.

Definition at line 678 of file array.icc.

template<class View>
bool Gecode::ViewArray< View >::same ( const View &  y  )  const

Test whether array contains a view being the same as y.

Definition at line 693 of file array.icc.

template<class View>
void Gecode::ViewArray< View >::unique ( void   ) 

Remove all duplicate views from array (changes element order).

Definition at line 702 of file array.icc.

template<class View>
bool Gecode::ViewArray< View >::shared ( void   )  const

Test whether array has shared views.

Definition at line 715 of file array.icc.

template<class View>
bool Gecode::ViewArray< View >::shared ( const View &  y  )  const

Test whether array contains view shared with y.

Definition at line 730 of file array.icc.


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