Generated on Tue Feb 11 2025 17:33:26 for Gecode by doxygen 1.12.0
Gecode::IntVarArgs Class Reference

Passing integer variables. More...

#include <int.hh>

Constructors and initialization

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

Additional Inherited Members

- Public Types inherited from Gecode::ArgArrayBase< IntVar >
typedef IntVar value_type
 Type of the view stored in this array.
 
typedef IntVarreference
 Type of a reference to the value type.
 
typedef const IntVarconst_reference
 Type of a constant reference to the value type.
 
typedef IntVarpointer
 Type of a pointer to the value type.
 
typedef const IntVarconst_pointer
 Type of a read-only pointer to the value type.
 
typedef IntVariterator
 Type of the iterator used to iterate through this array's elements.
 
typedef const IntVarconst_iterator
 Type of the iterator used to iterate read-only through this array's elements.
 
typedef std::reverse_iterator< IntVar * > reverse_iterator
 Type of the iterator used to iterate backwards through this array's elements.
 
typedef std::reverse_iterator< const IntVar * > 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::VarArgArray< IntVar >
 VarArgArray (void)
 Allocate empty array.
 
 VarArgArray (int n)
 Allocate array with n elements.
 
 VarArgArray (const VarArgArray< IntVar > &a)
 Initialize from variable argument array a (copy elements)
 
 VarArgArray (const VarArray< IntVar > &a)
 Initialize from variable array a (copy elements)
 
 VarArgArray (const std::vector< IntVar > &a)
 Initialize from vector a.
 
 VarArgArray (std::initializer_list< IntVar > a)
 Initialize from initializer list a.
 
 VarArgArray (InputIterator first, InputIterator last)
 Initialize from InputIterator first and last.
 
ArrayTraits< VarArgArray< IntVar > >::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}}$.
 
ArrayTraits< VarArgArray< IntVar > >::ArgsType & operator<< (const IntVar &x)
 Insert a new element x at the end of the array (increase size by 1)
 
ArrayTraits< VarArgArray< IntVar > >::ArgsType & operator<< (const VarArgArray< IntVar > &x)
 Append x to the end of the array.
 
bool assigned (void) const
 Test if all variables are assigned.
 
- Public Member Functions inherited from Gecode::ArgArrayBase< IntVar >
 ArgArrayBase (void)
 Allocate empty array.
 
 ArgArrayBase (int n)
 Allocate array with n elements.
 
 ArgArrayBase (const ArgArrayBase< IntVar > &a)
 Initialize from argument array a (copy elements)
 
 ArgArrayBase (const std::vector< IntVar > &a)
 Initialize from vector a.
 
 ArgArrayBase (std::initializer_list< IntVar > a)
 Initialize from initializer list a.
 
 ArgArrayBase (InputIterator first, InputIterator last)
 Initialize from InputIterator begin and end.
 
const ArgArrayBase< IntVar > & operator= (const ArgArrayBase< IntVar > &a)
 Initialize from view array a (copy elements)
 
int size (void) const
 Return size of array (number of elements)
 
IntVaroperator[] (int i)
 Return element at position i.
 
const IntVaroperator[] (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< IntVar >
IntVarallocate (int n)
 Allocate memory for n elements.
 
void resize (int i)
 Resize to hold at least i additional elements.
 
concat (const ArgArrayBase< IntVar > &x) const
 Return this array concatenated with x.
 
concat (const IntVar &x) const
 Return this array concatenated with x.
 
A & append (const IntVar &x)
 Insert a new element x at the end of the array (increase size by 1)
 
A & append (const ArgArrayBase< IntVar > &x)
 Append x to the end of the array.
 
slice (int start, int inc=1, int n=-1)
 
- Protected Attributes inherited from Gecode::ArgArrayBase< IntVar >
int n
 Number of elements.
 
int capacity
 Allocated size of the array.
 
IntVara
 Element array.
 
IntVar onstack [onstack_size]
 In-array storage for elements.
 
- Static Protected Attributes inherited from Gecode::ArgArrayBase< IntVar >
static const int onstack_size
 How many elements are possible inside array.
 

Detailed Description

Passing integer variables.

Definition at line 656 of file int.hh.

Constructor & Destructor Documentation

◆ IntVarArgs() [1/9]

Gecode::IntVarArgs::IntVarArgs ( void )
inline

Allocate empty array.

Definition at line 85 of file array.hpp.

◆ IntVarArgs() [2/9]

Gecode::IntVarArgs::IntVarArgs ( int n)
inlineexplicit

Allocate array with n elements.

Definition at line 88 of file array.hpp.

◆ IntVarArgs() [3/9]

Gecode::IntVarArgs::IntVarArgs ( const IntVarArgs & a)
inline

Initialize from variable argument array a (copy elements)

Definition at line 92 of file array.hpp.

◆ IntVarArgs() [4/9]

Gecode::IntVarArgs::IntVarArgs ( const VarArray< IntVar > & a)
inline

Initialize from variable array a (copy elements)

Definition at line 96 of file array.hpp.

◆ IntVarArgs() [5/9]

Gecode::IntVarArgs::IntVarArgs ( const std::vector< IntVar > & a)
inline

Initialize from a.

Definition at line 100 of file array.hpp.

◆ IntVarArgs() [6/9]

Gecode::IntVarArgs::IntVarArgs ( std::initializer_list< IntVar > a)
inline

Initialize from a.

Definition at line 104 of file array.hpp.

◆ IntVarArgs() [7/9]

template<class InputIterator >
Gecode::IntVarArgs::IntVarArgs ( InputIterator first,
InputIterator last )
inline

Initialize from InputIterator first and last.

Definition at line 109 of file array.hpp.

◆ IntVarArgs() [8/9]

Gecode::IntVarArgs::IntVarArgs ( 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:

Definition at line 68 of file array.cpp.

◆ IntVarArgs() [9/9]

Gecode::IntVarArgs::IntVarArgs ( Space & home,
int n,
const IntSet & s )

Initialize array with n new variables.

The variables are created with a domain described by s. The following execptions might be thrown:

Definition at line 78 of file array.cpp.


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