Bayesian Filtering Library  Generated from SVN r
Public Types | Public Member Functions | Static Public Attributes | List of all members
bounded_vector< T, N > Class Template Reference

a dense vector of values of type T, of variable size but with maximum $N$. A dense vector of values of type T, of variable size but with maximum $N$. The default constructor creates the vector with size $N$. Elements are constructed by the storage type bounded_array, which need not initialise their value. More...

#include <asirfilter.h>

Inheritance diagram for bounded_vector< T, N >:
vector< T, bounded_array< T, N > > vector_container< vector< T, bounded_array< T, N > > > vector_expression< vector< T, bounded_array< T, N > > > ublas_expression< vector< T, bounded_array< T, N > > >

Public Types

typedef vector_type::size_type size_type
 
typedef bounded_array< T, N >
::difference_type 
difference_type
 
typedef T value_type
 
typedef type_traits< T >
::const_reference 
const_reference
 
typedef T & reference
 
typedef T * pointer
 
typedef const T * const_pointer
 
typedef bounded_array< T, N > array_type
 
typedef const vector_reference
< const self_type
const_closure_type
 
typedef vector_reference
< self_type
closure_type
 
typedef self_type vector_temporary_type
 
typedef dense_tag storage_category
 
typedef reverse_iterator_base
< const_iterator > 
const_reverse_iterator
 
typedef reverse_iterator_base
< iterator
reverse_iterator
 
typedef vector< T,
bounded_array< T, N > > 
container_type
 
typedef vector_tag type_category
 
typedef vector< T,
bounded_array< T, N > > 
expression_type
 

Public Member Functions

BOOST_UBLAS_INLINE bounded_vector (size_type size)
 
BOOST_UBLAS_INLINE bounded_vector (const bounded_vector &v)
 
template<class A2 >
BOOST_UBLAS_INLINE bounded_vector (const vector< T, A2 > &v)
 
template<class AE >
BOOST_UBLAS_INLINE bounded_vector (const vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE bounded_vectoroperator= (const bounded_vector &v)
 
template<class A2 >
BOOST_UBLAS_INLINE bounded_vectoroperator= (const vector< T, A2 > &v)
 
template<class C >
BOOST_UBLAS_INLINE bounded_vectoroperator= (const vector_container< C > &v)
 
template<class AE >
BOOST_UBLAS_INLINE bounded_vectoroperator= (const vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE size_type max_size () const
 Return the maximum size of the data container. Return the upper bound (maximum size) on the data container. Depending on the container, it can be bigger than the current size of the vector.
 
BOOST_UBLAS_INLINE bool empty () const
 Return true if the vector is empty (size==0) More...
 
BOOST_UBLAS_INLINE size_type size () const
 Return the size of the vector.
 
BOOST_UBLAS_INLINE const
array_type
data () const
 Return a const reference to the container. Useful to access data directly for specific type of container.
 
BOOST_UBLAS_INLINE array_typedata ()
 Return a reference to the container. Useful to speed-up write operations to the data in very specific case.
 
BOOST_UBLAS_INLINE void resize (size_type size, bool preserve=true)
 Resize the vector Resize the vector to a new size. If preserve is true, data are copied otherwise data are lost. If the new size is bigger, the remaining values are filled in with the initial value (0 by default) in the case of unbounded_array, which is the container by default. If the new size is smaller, last values are lost. This behaviour can be different if you explicitely specify another type of container. More...
 
BOOST_UBLAS_INLINE pointer find_element (size_type i)
 Return a pointer to the element $i$. More...
 
BOOST_UBLAS_INLINE const_pointer find_element (size_type i) const
 Return a const pointer to the element $i$. More...
 
BOOST_UBLAS_INLINE const_reference operator() (size_type i) const
 Return a const reference to the element $i$ Return a const reference to the element $i$. With some compilers, this notation will be faster than [i]. More...
 
BOOST_UBLAS_INLINE reference operator() (size_type i)
 Return a reference to the element $i$ Return a reference to the element $i$. With some compilers, this notation will be faster than [i]. More...
 
BOOST_UBLAS_INLINE const
container_type
operator() () const
 
BOOST_UBLAS_INLINE container_typeoperator() ()
 
BOOST_UBLAS_INLINE const_reference operator[] (size_type i) const
 Return a const reference to the element $i$. More...
 
BOOST_UBLAS_INLINE reference operator[] (size_type i)
 Return a reference to the element $i$. More...
 
BOOST_UBLAS_INLINE reference insert_element (size_type i, const_reference t)
 Set element $i$ to the value t. More...
 
BOOST_UBLAS_INLINE void erase_element (size_type i)
 Set element $i$ to the zero value. More...
 
BOOST_UBLAS_INLINE void clear ()
 Clear the vector, i.e. set all values to the zero value.
 
BOOST_UBLAS_INLINE vectorassign_temporary (vector &v)
 Assign a full vector (RHS-vector) to the current vector (LHS-vector) More...
 
BOOST_UBLAS_INLINE vectorassign (const vector_expression< AE > &ae)
 Assign the result of a vector_expression to the vector Assign the result of a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. More...
 
BOOST_UBLAS_INLINE vectoroperator+= (const vector_expression< AE > &ae)
 Assign the sum of the vector and a vector_expression to the vector Assign the sum of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. A temporary is created for the computations. More...
 
BOOST_UBLAS_INLINE vectoroperator+= (const vector_container< C > &v)
 Assign the sum of the vector and a vector_expression to the vector Assign the sum of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector. More...
 
BOOST_UBLAS_INLINE vectorplus_assign (const vector_expression< AE > &ae)
 Assign the sum of the vector and a vector_expression to the vector Assign the sum of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector. More...
 
BOOST_UBLAS_INLINE vectoroperator-= (const vector_expression< AE > &ae)
 Assign the difference of the vector and a vector_expression to the vector Assign the difference of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. A temporary is created for the computations. More...
 
BOOST_UBLAS_INLINE vectoroperator-= (const vector_container< C > &v)
 Assign the difference of the vector and a vector_expression to the vector Assign the difference of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector. More...
 
BOOST_UBLAS_INLINE vectorminus_assign (const vector_expression< AE > &ae)
 Assign the difference of the vector and a vector_expression to the vector Assign the difference of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector. More...
 
BOOST_UBLAS_INLINE vectoroperator*= (const AT &at)
 Assign the product of the vector and a scalar to the vector Assign the product of the vector and a scalar to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector. More...
 
BOOST_UBLAS_INLINE vectoroperator/= (const AT &at)
 Assign the division of the vector by a scalar to the vector Assign the division of the vector by a scalar to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector. More...
 
BOOST_UBLAS_INLINE void swap (vector &v)
 Swap the content of the vector with another vector. More...
 
BOOST_UBLAS_INLINE const_iterator find (size_type i) const
 Return a const iterator to the element i. More...
 
BOOST_UBLAS_INLINE iterator find (size_type i)
 Return an iterator to the element i. More...
 
BOOST_UBLAS_INLINE const_iterator begin () const
 return an iterator on the first element of the vector
 
BOOST_UBLAS_INLINE iterator begin ()
 Return an iterator on the first element of the vector.
 
BOOST_UBLAS_INLINE const_iterator end () const
 return an iterator after the last element of the vector
 
BOOST_UBLAS_INLINE iterator end ()
 Return an iterator at the end of the vector.
 
BOOST_UBLAS_INLINE
const_reverse_iterator 
rbegin () const
 Return a const reverse iterator before the first element of the reversed vector (i.e. end() of normal vector)
 
BOOST_UBLAS_INLINE reverse_iterator rbegin ()
 Return a const reverse iterator before the first element of the reversed vector (i.e. end() of normal vector)
 
BOOST_UBLAS_INLINE
const_reverse_iterator 
rend () const
 Return a const reverse iterator on the end of the reverse vector (i.e. first element of the normal vector)
 
BOOST_UBLAS_INLINE reverse_iterator rend ()
 Return a const reverse iterator on the end of the reverse vector (i.e. first element of the normal vector)
 
void serialize (Archive &ar, const unsigned int)
 

Static Public Attributes

static const size_type max_size = N
 
static const unsigned complexity
 

Detailed Description

template<class T, std::size_t N>
class BFL::boost::numeric::ublas::bounded_vector< T, N >

a dense vector of values of type T, of variable size but with maximum $N$. A dense vector of values of type T, of variable size but with maximum $N$. The default constructor creates the vector with size $N$. Elements are constructed by the storage type bounded_array, which need not initialise their value.

Definition at line 92 of file asirfilter.h.

Member Function Documentation

BOOST_UBLAS_INLINE vector& assign ( const vector_expression< AE > &  ae)
inlineinherited

Assign the result of a vector_expression to the vector Assign the result of a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression
Returns
a reference to the resulting vector

Definition at line 332 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& assign_temporary ( vector< T, bounded_array< T, N > > &  v)
inlineinherited

Assign a full vector (RHS-vector) to the current vector (LHS-vector)

Parameters
vis the source vector
Returns
a reference to a vector (i.e. the destination vector)

Definition at line 308 of file asirfilter.h.

BOOST_UBLAS_INLINE bool empty ( ) const
inlineinherited

Return true if the vector is empty (size==0)

Returns
true if empty, false otherwise

Definition at line 139 of file asirfilter.h.

BOOST_UBLAS_INLINE void erase_element ( size_type  i)
inlineinherited

Set element $i$ to the zero value.

Parameters
iindex of the element

Definition at line 255 of file asirfilter.h.

BOOST_UBLAS_INLINE const_iterator find ( size_type  i) const
inlineinherited

Return a const iterator to the element i.

Parameters
iindex of the element

Definition at line 487 of file asirfilter.h.

BOOST_UBLAS_INLINE iterator find ( size_type  i)
inlineinherited

Return an iterator to the element i.

Parameters
iindex of the element

Definition at line 498 of file asirfilter.h.

BOOST_UBLAS_INLINE pointer find_element ( size_type  i)
inlineinherited

Return a pointer to the element $i$.

Parameters
iindex of the element

Definition at line 193 of file asirfilter.h.

BOOST_UBLAS_INLINE const_pointer find_element ( size_type  i) const
inlineinherited

Return a const pointer to the element $i$.

Parameters
iindex of the element

Definition at line 201 of file asirfilter.h.

BOOST_UBLAS_INLINE reference insert_element ( size_type  i,
const_reference  t 
)
inlineinherited

Set element $i$ to the value t.

Parameters
iindex of the element
treference to the value to be set

Definition at line 248 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& minus_assign ( const vector_expression< AE > &  ae)
inlineinherited

Assign the difference of the vector and a vector_expression to the vector Assign the difference of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression
Returns
a reference to the resulting vector

Definition at line 413 of file asirfilter.h.

BOOST_UBLAS_INLINE const_reference operator() ( size_type  i) const
inlineinherited

Return a const reference to the element $i$ Return a const reference to the element $i$. With some compilers, this notation will be faster than [i].

Parameters
iindex of the element

Definition at line 213 of file asirfilter.h.

BOOST_UBLAS_INLINE reference operator() ( size_type  i)
inlineinherited

Return a reference to the element $i$ Return a reference to the element $i$. With some compilers, this notation will be faster than [i].

Parameters
iindex of the element

Definition at line 221 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& operator*= ( const AT &  at)
inlineinherited

Assign the product of the vector and a scalar to the vector Assign the product of the vector and a scalar to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector.

Template Parameters
AEis the type of the vector_expression
Parameters
atis a const reference to the scalar
Returns
a reference to the resulting vector

Definition at line 426 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& operator+= ( const vector_expression< AE > &  ae)
inlineinherited

Assign the sum of the vector and a vector_expression to the vector Assign the sum of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. A temporary is created for the computations.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression
Returns
a reference to the resulting vector

Definition at line 349 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& operator+= ( const vector_container< C > &  v)
inlineinherited

Assign the sum of the vector and a vector_expression to the vector Assign the sum of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression
Returns
a reference to the resulting vector

Definition at line 362 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& operator-= ( const vector_expression< AE > &  ae)
inlineinherited

Assign the difference of the vector and a vector_expression to the vector Assign the difference of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. A temporary is created for the computations.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression

Definition at line 387 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& operator-= ( const vector_container< C > &  v)
inlineinherited

Assign the difference of the vector and a vector_expression to the vector Assign the difference of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression
Returns
a reference to the resulting vector

Definition at line 400 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& operator/= ( const AT &  at)
inlineinherited

Assign the division of the vector by a scalar to the vector Assign the division of the vector by a scalar to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector.

Template Parameters
AEis the type of the vector_expression
Parameters
atis a const reference to the scalar
Returns
a reference to the resulting vector

Definition at line 439 of file asirfilter.h.

BOOST_UBLAS_INLINE const_reference operator[] ( size_type  i) const
inlineinherited

Return a const reference to the element $i$.

Parameters
iindex of the element

Definition at line 228 of file asirfilter.h.

BOOST_UBLAS_INLINE reference operator[] ( size_type  i)
inlineinherited

Return a reference to the element $i$.

Parameters
iindex of the element

Definition at line 235 of file asirfilter.h.

BOOST_UBLAS_INLINE vector& plus_assign ( const vector_expression< AE > &  ae)
inlineinherited

Assign the sum of the vector and a vector_expression to the vector Assign the sum of the vector and a vector_expression to the vector. This is lazy-compiled and will be optimized out by the compiler on any type of expression. No temporary is created. Computations are done and stored directly into the resulting vector.

Template Parameters
AEis the type of the vector_expression
Parameters
aeis a const reference to the vector_expression
Returns
a reference to the resulting vector

Definition at line 375 of file asirfilter.h.

BOOST_UBLAS_INLINE void resize ( size_type  size,
bool  preserve = true 
)
inlineinherited

Resize the vector Resize the vector to a new size. If preserve is true, data are copied otherwise data are lost. If the new size is bigger, the remaining values are filled in with the initial value (0 by default) in the case of unbounded_array, which is the container by default. If the new size is smaller, last values are lost. This behaviour can be different if you explicitely specify another type of container.

Parameters
sizenew size of the vector
preserveif true, keep values

Definition at line 178 of file asirfilter.h.

void serialize ( Archive &  ar,
const unsigned int   
)
inlineinherited

Serialize a vector into and archive as defined in Boost

Parameters
arArchive object. Can be a flat file, an XML file or any other stream
file_versionOptional file version (not yet used)

Definition at line 787 of file asirfilter.h.

BOOST_UBLAS_INLINE void swap ( vector< T, bounded_array< T, N > > &  v)
inlineinherited

Swap the content of the vector with another vector.

Parameters
vis the vector to be swapped with

Definition at line 451 of file asirfilter.h.


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