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

View arrays. More...

#include <array.hpp>

List of all members.

Public Member Functions
bool	assigned (void) const
	Test if all variables are assigned.
Related Functions
(Note that these are not member functions.)
template<class Char , class Traits , class View >
std::basic_ostream< Char, Traits > &	operator<< (std::basic_ostream< Char, Traits > &os, const ViewArray< View > &x)
	Print array elements enclosed in curly brackets.
Associated types
typedef View	value_type
	Type of the view stored in this array.
typedef View &	reference
	Type of a reference to the value type.
typedef const View &	const_reference
	Type of a constant reference to the value type.
typedef View *	pointer
	Type of a pointer to the value type.
typedef const View *	const_pointer
	Type of a read-only pointer to the value type.
typedef View *	iterator
	Type of the iterator used to iterate through this array's elements.
typedef const View *	const_iterator
	Type of the iterator used to iterate read-only through this array's elements.
typedef std::reverse_iterator < View * >	reverse_iterator
	Type of the iterator used to iterate backwards through this array's elements.
typedef std::reverse_iterator < const View * >	const_reverse_iterator
	Type of the iterator used to iterate backwards and read-only through this array's elements.
Constructors and initialization
	ViewArray (void)
	Default constructor (array of size 0).
	ViewArray (Space &home, int m)
	Allocate array with m views.
	ViewArray (Region &r, int m)
	Allocate array with m views.
	ViewArray (const ViewArray< View > &a)
	Initialize from view array a (share elements).
	ViewArray (Space &home, const ViewArray< View > &a)
	Initialize from view array a (copy elements).
	ViewArray (Region &r, 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).
template<class Var >
	ViewArray (Region &r, 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.
Array iteration
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.
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.
void	subscribe (Space &home, Advisor &a)
	Subscribe advisor a to variable.
void	cancel (Space &home, Advisor &a)
	Cancel subscription of advisor a.
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 view from position 0 to position i (shift elements to the left).
void	move_lst (int i)
	Move 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).
void	move_fst (int i, Space &home, Advisor &a)
	Move view from position 0 to position i (shift elements to the left).
void	move_lst (int i, Space &home, Advisor &a)
	Move view from position size()-1 to position i (truncate array by one).
Dropping elements
void	drop_fst (int i)
	Drop views from positions 0 to i-1 from array.
void	drop_lst (int i)
	Drop 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.
void	drop_fst (int i, Space &home, Advisor &a)
	Drop views from positions 0 to i-1 from array.
void	drop_lst (int i, Space &home, Advisor &a)
	Drop assigned views from positions i+1 to size()-1 from array.
View equality
bool	same (const Space &home) const
	Test whether array has multiple occurence of the same view.
bool	same (const Space &home, const View &y) const
	Test whether array contains a view being the same as y.
void	unique (const Space &home)
	Remove all duplicate views from array (changes element order).
View sharing
bool	shared (const Space &home) const
	Test whether array contains shared views.
template<class ViewY >
bool	shared (const Space &home, const ViewY &y) const
	Test whether array contains a view being shared with y.
template<class ViewY >
bool	shared (const Space &home, const ViewArray< ViewY > &y) const
	Test whether array together with array y contains shared views.

---

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 branchers compute.

Definition at line 234 of file array.hpp.

---

Member Typedef Documentation

template<class View>

typedef View Gecode::ViewArray< View >::value_type

Type of the view stored in this array.

Definition at line 252 of file array.hpp.

template<class View>

typedef View& Gecode::ViewArray< View >::reference

Type of a reference to the value type.

Definition at line 254 of file array.hpp.

template<class View>

typedef const View& Gecode::ViewArray< View >::const_reference

Type of a constant reference to the value type.

Definition at line 256 of file array.hpp.

template<class View>

typedef View* Gecode::ViewArray< View >::pointer

Type of a pointer to the value type.

Definition at line 258 of file array.hpp.

template<class View>

typedef const View* Gecode::ViewArray< View >::const_pointer

Type of a read-only pointer to the value type.

Definition at line 260 of file array.hpp.

template<class View>

typedef View* Gecode::ViewArray< View >::iterator

Type of the iterator used to iterate through this array's elements.

Definition at line 262 of file array.hpp.

template<class View>

typedef const View* Gecode::ViewArray< View >::const_iterator

Type of the iterator used to iterate read-only through this array's elements.

Definition at line 264 of file array.hpp.

template<class View>

typedef std::reverse_iterator<View*> Gecode::ViewArray< View >::reverse_iterator

Type of the iterator used to iterate backwards through this array's elements.

Definition at line 266 of file array.hpp.

template<class View>

typedef std::reverse_iterator<const View*> Gecode::ViewArray< View >::const_reverse_iterator

Type of the iterator used to iterate backwards and read-only through this array's elements.

Definition at line 268 of file array.hpp.

---

Constructor & Destructor Documentation

template<class View >

Gecode::ViewArray< View >::ViewArray

(

void

)

[inline]

Default constructor (array of size 0).

Definition at line 1163 of file array.hpp.

template<class View >

Gecode::ViewArray< View >::ViewArray	(	Space &	home,
		int	m
	)			[inline]

Allocate array with m views.

Definition at line 1167 of file array.hpp.

template<class View >

Gecode::ViewArray< View >::ViewArray	(	Region &	r,
		int	m
	)			[inline]

Allocate array with m views.

Definition at line 1173 of file array.hpp.

template<class View>

Gecode::ViewArray< View >::ViewArray

(

const ViewArray< View > &

a

)

[inline]

Initialize from view array a (share elements).

Definition at line 1203 of file array.hpp.

template<class View>

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

Initialize from view array a (copy elements).

Definition at line 1179 of file array.hpp.

template<class View>

Gecode::ViewArray< View >::ViewArray	(	Region &	r,
		const ViewArray< View > &	a
	)			[inline]

Initialize from view array a (copy elements).

Definition at line 1190 of file array.hpp.

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

template<class View>

template<class Var >

Gecode::ViewArray< View >::ViewArray	(	Region &	r,
		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 312 of file array.hpp.

---

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

template<class View >

int Gecode::ViewArray< View >::size

(

void

)

const [inline]

Return size of array (number of elements).

Definition at line 1215 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::size

(

int

n

)

[inline]

Decrease size of array (number of elements).

Definition at line 1221 of file array.hpp.

template<class View >

View & Gecode::ViewArray< View >::operator[]

(

int

i

)

[inline]

Return view at position i.

Definition at line 1227 of file array.hpp.

template<class View >

const View & Gecode::ViewArray< View >::operator[]

(

int

i

)

const [inline]

Return view at position i.

Definition at line 1234 of file array.hpp.

template<class View >

ViewArray< View >::iterator Gecode::ViewArray< View >::begin

(

void

)

[inline]

Return an iterator at the beginning of the array.

Definition at line 1241 of file array.hpp.

template<class View >

ViewArray< View >::const_iterator Gecode::ViewArray< View >::begin

(

void

)

const [inline]

Return a read-only iterator at the beginning of the array.

Definition at line 1247 of file array.hpp.

template<class View >

ViewArray< View >::iterator Gecode::ViewArray< View >::end

(

void

)

[inline]

Return an iterator past the end of the array.

Definition at line 1253 of file array.hpp.

template<class View >

ViewArray< View >::const_iterator Gecode::ViewArray< View >::end

(

void

)

const [inline]

Return a read-only iterator past the end of the array.

Definition at line 1259 of file array.hpp.

template<class View >

ViewArray< View >::reverse_iterator Gecode::ViewArray< View >::rbegin

(

void

)

[inline]

Return a reverse iterator at the end of the array.

Definition at line 1265 of file array.hpp.

template<class View >

ViewArray< View >::const_reverse_iterator Gecode::ViewArray< View >::rbegin

(

void

)

const [inline]

Return a reverse and read-only iterator at the end of the array.

Definition at line 1271 of file array.hpp.

template<class View >

ViewArray< View >::reverse_iterator Gecode::ViewArray< View >::rend

(

void

)

[inline]

Return a reverse iterator past the beginning of the array.

Definition at line 1277 of file array.hpp.

template<class View >

ViewArray< View >::const_reverse_iterator Gecode::ViewArray< View >::rend

(

void

)

const [inline]

Return a reverse and read-only iterator past the beginning of the array.

Definition at line 1283 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::subscribe	(	Space &	home,
		Propagator &	p,
		PropCond	pc,
		bool	process = true
	)			[inline]

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

template<class View >

void Gecode::ViewArray< View >::cancel	(	Space &	home,
		Propagator &	p,
		PropCond	pc
	)			[inline]

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

Definition at line 1408 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::subscribe	(	Space &	home,
		Advisor &	a
	)			[inline]

Subscribe advisor a to variable.

Definition at line 1415 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::cancel	(	Space &	home,
		Advisor &	a
	)			[inline]

Cancel subscription of advisor a.

Definition at line 1422 of file array.hpp.

template<class View>

void Gecode::ViewArray< View >::update	(	Space &	home,
		bool	share,
		ViewArray< View > &	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 1387 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::move_fst

(

int

i

)

[inline]

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

Definition at line 1289 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::move_lst

(

int

i

)

[inline]

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

Definition at line 1295 of file array.hpp.

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

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

template<class View >

void Gecode::ViewArray< View >::move_fst	(	int	i,
		Space &	home,
		Advisor &	a
	)			[inline]

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

Before moving, cancel subscription of advisor a to view at position i.

Definition at line 1351 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::move_lst	(	int	i,
		Space &	home,
		Advisor &	a
	)			[inline]

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

Before moving, cancel subscription of advisor a to view at position i.

Definition at line 1359 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::drop_fst

(

int

i

)

[inline]

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

Definition at line 1301 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::drop_lst

(

int

i

)

[inline]

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

Definition at line 1308 of file array.hpp.

template<class View >

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

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

template<class View >

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

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

template<class View >

void Gecode::ViewArray< View >::drop_fst	(	int	i,
		Space &	home,
		Advisor &	a
	)			[inline]

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

Before moving, cancel subscription of advisor a to views at positions 0 to i-1.

Definition at line 1367 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::drop_lst	(	int	i,
		Space &	home,
		Advisor &	a
	)			[inline]

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

Before moving, cancel subscription of advisor a to views at positions i+1 to size()-1.

Definition at line 1377 of file array.hpp.

template<class View >

bool Gecode::ViewArray< View >::assigned

(

void

)

const [inline]

Test if all variables are assigned.

Definition at line 1429 of file array.hpp.

template<class View >

bool Gecode::ViewArray< View >::same

(

const Space &

home

)

const [inline]

Test whether array has multiple occurence of the same view.

Note that assigned views are ignored.

Definition at line 1468 of file array.hpp.

template<class View>

bool Gecode::ViewArray< View >::same	(	const Space &	home,
		const View &	y
	)			const [inline]

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

Note that assigned views are ignored.

Definition at line 1487 of file array.hpp.

template<class View >

void Gecode::ViewArray< View >::unique

(

const Space &

home

)

[inline]

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

Definition at line 1498 of file array.hpp.

template<class View >

bool Gecode::ViewArray< View >::shared

(

const Space &

home

)

const [inline]

Test whether array contains shared views.

Note that assigned views are ignored.

Definition at line 1511 of file array.hpp.

template<class View >

template<class ViewY >

bool Gecode::ViewArray< View >::shared	(	const Space &	home,
		const ViewY &	y
	)			const [inline]

Test whether array contains a view being shared with y.

Note that assigned views are ignored.

Definition at line 1530 of file array.hpp.

template<class View >

template<class ViewY >

bool Gecode::ViewArray< View >::shared	(	const Space &	home,
		const ViewArray< ViewY > &	y
	)			const [inline]

Test whether array together with array y contains shared views.

Note that assigned views are ignored.

Definition at line 1541 of file array.hpp.

---

Friends And Related Function Documentation

template<class Char , class Traits , class View >

std::basic_ostream< Char, Traits > & operator<<	(	std::basic_ostream< Char, Traits > &	os,
		const ViewArray< View > &	x
	)			[related]

Print array elements enclosed in curly brackets.

Definition at line 2183 of file array.hpp.

---

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

• gecode/kernel/array.hpp (Revision: 14294)