Gecode::BoolVarArgs Class Reference

Passing Boolean variables. More...

`#include <int.hh>`

## Constructors and initialization

| BoolVarArgs (void)
| Allocate empty array.
| BoolVarArgs (int n)
| Allocate array with n elements.
| BoolVarArgs (const BoolVarArgs &a)
| Initialize from variable argument array a (copy elements).
| BoolVarArgs (const VarArray< BoolVar > &a)
| Initialize from variable array a (copy elements).
| BoolVarArgs (const std::vector< BoolVar > &a)
| Initialize from a.
| BoolVarArgs (std::initializer_list< BoolVar > a)
| Initialize from a.
template<class InputIterator>
| BoolVarArgs (InputIterator first, InputIterator last)
| Initialize from InputIterator first and last.
| BoolVarArgs (Space &home, int n, int min, int max)
| Initialize array with n new variables.

## Additional Inherited Members

typedef BoolVar | value_type
| Type of the view stored in this array.
typedef BoolVar & | reference
| Type of a reference to the value type.
typedef const BoolVar & | const_reference
| Type of a constant reference to the value type.
typedef BoolVar * | pointer
| Type of a pointer to the value type.
typedef const BoolVar * | const_pointer
| Type of a read-only pointer to the value type.
typedef BoolVar * | iterator
| Type of the iterator used to iterate through this array's elements.
typedef const BoolVar * | const_iterator
| Type of the iterator used to iterate read-only through this array's elements.
typedef std::reverse_iterator< BoolVar * > | reverse_iterator
| Type of the iterator used to iterate backwards through this array's elements.
typedef std::reverse_iterator< const BoolVar * > | const_reverse_iterator
| Type of the iterator used to iterate backwards and read-only through this array's elements.
| VarArgArray (void)
| Allocate empty array.
ArrayTraits< VarArgArray< BoolVar > >::ArgsType | slice (int start, int inc=1, int n=-1)
| Return slice of length n such that forall , .
ArrayTraits< VarArgArray< BoolVar > >::ArgsType & | operator<< (const BoolVar &x)
| Insert a new element x at the end of the array (increase size by 1).
bool | assigned (void) const
| Test if all variables are assigned.
| ArgArrayBase (void)
| Allocate empty array.
const ArgArrayBase< BoolVar > & | operator= (const ArgArrayBase< BoolVar > &a)
| Initialize from view array a (copy elements).
int | size (void) const
| Return size of array (number of elements).
BoolVar & | operator[] (int i)
| Return element at position i.
iterator | begin (void)
| Return an iterator at the beginning of the array.
iterator | end (void)
| Return an iterator past the end of the array.
reverse_iterator | rbegin (void)
| Return a reverse iterator at the end of the array.
reverse_iterator | rend (void)
| Return a reverse iterator past the beginning of the array.
| ~ArgArrayBase (void)
| Destructor.
Protected Member Functions inherited from Gecode::ArgArrayBase< BoolVar >
BoolVar * | allocate (int n)
| Allocate memory for n elements.
void | resize (int i)
| Resize to hold at least i additional elements.
A | concat (const ArgArrayBase< BoolVar > &x) const
| Return this array concatenated with x.
A & | append (const BoolVar &x)
| Insert a new element x at the end of the array (increase size by 1).
A | slice (int start, int inc=1, int n=-1)
Protected Attributes inherited from Gecode::ArgArrayBase< BoolVar >
int | n
| Number of elements.
int | capacity
| Allocated size of the array.
BoolVar * | a
| Element array.
BoolVar | onstack [onstack_size]
| In-array storage for elements.
Static Protected Attributes inherited from Gecode::ArgArrayBase< BoolVar >
static const int | onstack_size
| How many elements are possible inside array.
Related Symbols inherited from Gecode::VarArgArray< BoolVar >
bool | same (VarArgArray< BoolVar > x, VarArgArray< BoolVar > y)
| Test whether array x together with array y contains at least one variable being the same.
bool | same (VarArgArray< BoolVar > x, BoolVar y)
| Test whether array x contains variable y.
bool | same (BoolVar x, VarArgArray< BoolVar > y)
| Test whether array y contains variable x.
bool | same (VarArgArray< BoolVar > x)
| Test whether array x contains a variable multiply.
Related Symbols inherited from Gecode::ArgArrayBase< BoolVar >
std::basic_ostream< Char, Traits > & | operator<< (std::basic_ostream< Char, Traits > &os, const ArgArrayBase< BoolVar > &x)
| Print array elements enclosed in curly brackets.

## Detailed Description

Passing Boolean variables.

We could have used a simple typedef instead, but doxygen cannot resolve some overloading then, leading to unusable documentation for important parts of the library. As long as there is no fix for this, we will keep this workaround.

Definition at line 712 of file int.hh.

## Constructor & Destructor Documentation

## BoolVarArgs() [1/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | void |  | ) |

inline

Allocate empty array.

Definition at line 114 of file array.hpp.

## BoolVarArgs() [2/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | int | n | ) |

inline explicit

Allocate array with n elements.

Definition at line 117 of file array.hpp.

## BoolVarArgs() [3/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | const BoolVarArgs & | a | ) |

inline

Initialize from variable argument array a (copy elements).

Definition at line 121 of file array.hpp.

## BoolVarArgs() [4/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | const VarArray< BoolVar > & | a | ) |

inline

Initialize from variable array a (copy elements).

Definition at line 125 of file array.hpp.

## BoolVarArgs() [5/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | const std::vector< BoolVar > & | a | ) |

inline

Initialize from a.

Definition at line 129 of file array.hpp.

## BoolVarArgs() [6/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | std::initializer_list< BoolVar > | a | ) |

inline

Initialize from a.

Definition at line 133 of file array.hpp.

## BoolVarArgs() [7/8]

template<class InputIterator>

Gecode::BoolVarArgs::BoolVarArgs | ( | InputIterator | first,
|  | InputIterator | last )

inline

Initialize from InputIterator first and last.

Definition at line 138 of file array.hpp.

## BoolVarArgs() [8/8]

Gecode::BoolVarArgs::BoolVarArgs | ( | Space & | home,
|  | int | n,
|  | int | min,
|  | int | max )

Initialize array with n new variables.

The variables are created with a domain ranging from min to max. The following execptions might be thrown:

- If min is greater than max, an exception of type Gecode::Int::VariableEmptyDomain is thrown.
- If min is less than 0 or max is greater than 1, an exception of type Gecode::Int::NotZeroOne is thrown.

Definition at line 88 of file array.cpp.

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

- gecode/int.hh
- gecode/int/array.cpp
- gecode/int/array.hpp