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

Passing integer arguments. More...

#include <int.hh>

Constructors and initialization

 IntArgs (void)
 Allocate empty array.
 
 IntArgs (int n)
 Allocate array with n elements.
 
 IntArgs (const SharedArray< int > &x)
 Allocate array and copy elements from x.
 
 IntArgs (const std::vector< int > &x)
 Allocate array and copy elements from x.
 
 IntArgs (std::initializer_list< int > x)
 Allocate array and copy elements from x.
 
template<class InputIterator >
 IntArgs (InputIterator first, InputIterator last)
 Allocate array and copy elements from first to last.
 
 IntArgs (int n, const int *e)
 Allocate array with n elements and initialize with elements from array e.
 
 IntArgs (const ArgArray< int > &a)
 Initialize from primitive argument array a (copy elements)
 
static IntArgs create (int n, int start, int inc=1)
 Allocate array with n elements such that for all $0\leq i<n: x_i=\text{start}+i\cdot\text{inc}$.
 

Additional Inherited Members

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

Detailed Description

Passing integer arguments.

Definition at line 628 of file int.hh.

Constructor & Destructor Documentation

◆ IntArgs() [1/8]

Gecode::IntArgs::IntArgs ( void )
inline

Allocate empty array.

Definition at line 42 of file array.hpp.

◆ IntArgs() [2/8]

Gecode::IntArgs::IntArgs ( int n)
inlineexplicit

Allocate array with n elements.

Definition at line 45 of file array.hpp.

◆ IntArgs() [3/8]

Gecode::IntArgs::IntArgs ( const SharedArray< int > & x)
inline

Allocate array and copy elements from x.

Definition at line 48 of file array.hpp.

◆ IntArgs() [4/8]

Gecode::IntArgs::IntArgs ( const std::vector< int > & x)
inline

Allocate array and copy elements from x.

Definition at line 55 of file array.hpp.

◆ IntArgs() [5/8]

Gecode::IntArgs::IntArgs ( std::initializer_list< int > x)
inline

Allocate array and copy elements from x.

Definition at line 59 of file array.hpp.

◆ IntArgs() [6/8]

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

Allocate array and copy elements from first to last.

Definition at line 64 of file array.hpp.

◆ IntArgs() [7/8]

Gecode::IntArgs::IntArgs ( int n,
const int * e )
inline

Allocate array with n elements and initialize with elements from array e.

Definition at line 68 of file array.hpp.

◆ IntArgs() [8/8]

Gecode::IntArgs::IntArgs ( const ArgArray< int > & a)
inline

Initialize from primitive argument array a (copy elements)

Definition at line 72 of file array.hpp.

Member Function Documentation

◆ create()

IntArgs Gecode::IntArgs::create ( int n,
int start,
int inc = 1 )
inlinestatic

Allocate array with n elements such that for all $0\leq i<n: x_i=\text{start}+i\cdot\text{inc}$.

Definition at line 76 of file array.hpp.


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