Boost.uBlas 1.49
Linear Algebra in C++: matrices, vectors and numeric algorithms

boost::numeric::ublas::scalar_vector< T, ALLOC > Class Template Reference

A scalar (i.e. unique value) vector of type T and a given size A scalar (i.e. unique value) vector of type T and a given size. This is a virtual vector in the sense that no memory is allocated for storing the unique value more than once: it still acts like any other vector. However assigning a new value will change all the value at once. vector into a normal vector. It must first be assigned to another normal vector by any suitable means. Its memory footprint is constant. More...

#include <vector.hpp>

Inheritance diagram for boost::numeric::ublas::scalar_vector< T, ALLOC >:
Collaboration diagram for boost::numeric::ublas::scalar_vector< T, ALLOC >:

List of all members.

Classes

class  const_iterator

Public Types

typedef vector_reference
< self_type
closure_type
typedef const vector_reference
< const self_type
const_closure_type
typedef const T & const_reference
typedef reverse_iterator_base
< const_iterator
const_reverse_iterator
typedef scalar_vector< T, ALLOC > container_type
typedef ALLOC::difference_type difference_type
typedef scalar_vector< T, ALLOC > expression_type
typedef const_iterator iterator
typedef T & reference
typedef ALLOC::size_type size_type
typedef dense_tag storage_category
typedef vector_tag type_category
typedef T value_type

Public Member Functions

BOOST_UBLAS_INLINE scalar_vector ()
BOOST_UBLAS_INLINE scalar_vector (size_type size, const value_type &value=value_type(1))
BOOST_UBLAS_INLINE scalar_vector (const scalar_vector &v)
BOOST_UBLAS_INLINE scalar_vectorassign_temporary (scalar_vector &v)
BOOST_UBLAS_INLINE const_iterator begin () const
BOOST_UBLAS_INLINE const_iterator end () const
BOOST_UBLAS_INLINE const_iterator find (size_type i) const
BOOST_UBLAS_INLINE const_pointer find_element (size_type) const
BOOST_UBLAS_INLINE const
container_type
operator() () const
BOOST_UBLAS_INLINE container_typeoperator() ()
BOOST_UBLAS_INLINE const_reference operator() (size_type) const
BOOST_UBLAS_INLINE scalar_vectoroperator= (const scalar_vector &v)
BOOST_UBLAS_INLINE const_reference operator[] (size_type) const
BOOST_UBLAS_INLINE
const_reverse_iterator 
rbegin () const
BOOST_UBLAS_INLINE
const_reverse_iterator 
rend () const
BOOST_UBLAS_INLINE void resize (size_type size, bool=true)
template<class Archive >
void serialize (Archive &ar, const unsigned int)
BOOST_UBLAS_INLINE size_type size () const
BOOST_UBLAS_INLINE void swap (scalar_vector &v)

Static Public Attributes

static const unsigned complexity

Private Types

typedef const T * const_pointer
typedef size_type const_subiterator_type
typedef scalar_vector< T, ALLOC > self_type

Private Attributes

size_type size_
value_type value_

Friends

BOOST_UBLAS_INLINE friend void swap (scalar_vector &v1, scalar_vector &v2)

Detailed Description

template<class T, class ALLOC>
class boost::numeric::ublas::scalar_vector< T, ALLOC >

A scalar (i.e. unique value) vector of type T and a given size A scalar (i.e. unique value) vector of type T and a given size. This is a virtual vector in the sense that no memory is allocated for storing the unique value more than once: it still acts like any other vector. However assigning a new value will change all the value at once. vector into a normal vector. It must first be assigned to another normal vector by any suitable means. Its memory footprint is constant.

Template Parameters:
Ttype of the objects stored in the vector: it can be anything even if most of the time, scalar types will be used like double or int. Complex types can be used, or even classes like boost::interval.

Definition at line 1322 of file vector.hpp.


Member Typedef Documentation

template<class T , class ALLOC >
typedef const T* boost::numeric::ublas::scalar_vector< T, ALLOC >::const_pointer [private]

Definition at line 1325 of file vector.hpp.

template<class T , class ALLOC >
typedef scalar_vector<T, ALLOC> boost::numeric::ublas::scalar_vector< T, ALLOC >::self_type [private]

Definition at line 1326 of file vector.hpp.

template<class T , class ALLOC >
typedef ALLOC::size_type boost::numeric::ublas::scalar_vector< T, ALLOC >::size_type

Definition at line 1331 of file vector.hpp.

template<class T , class ALLOC >
typedef ALLOC::difference_type boost::numeric::ublas::scalar_vector< T, ALLOC >::difference_type

Definition at line 1332 of file vector.hpp.

template<class T , class ALLOC >
typedef T boost::numeric::ublas::scalar_vector< T, ALLOC >::value_type

Definition at line 1333 of file vector.hpp.

template<class T , class ALLOC >
typedef const T& boost::numeric::ublas::scalar_vector< T, ALLOC >::const_reference

Definition at line 1334 of file vector.hpp.

template<class T , class ALLOC >
typedef T& boost::numeric::ublas::scalar_vector< T, ALLOC >::reference

Definition at line 1335 of file vector.hpp.

template<class T , class ALLOC >
typedef const vector_reference<const self_type> boost::numeric::ublas::scalar_vector< T, ALLOC >::const_closure_type

Definition at line 1336 of file vector.hpp.

template<class T , class ALLOC >
typedef vector_reference<self_type> boost::numeric::ublas::scalar_vector< T, ALLOC >::closure_type

Definition at line 1337 of file vector.hpp.

template<class T , class ALLOC >
typedef dense_tag boost::numeric::ublas::scalar_vector< T, ALLOC >::storage_category

Definition at line 1338 of file vector.hpp.

template<class T , class ALLOC >
typedef size_type boost::numeric::ublas::scalar_vector< T, ALLOC >::const_subiterator_type [private]

Definition at line 1412 of file vector.hpp.

template<class T , class ALLOC >
typedef const_iterator boost::numeric::ublas::scalar_vector< T, ALLOC >::iterator

Definition at line 1516 of file vector.hpp.

Definition at line 1529 of file vector.hpp.

typedef scalar_vector< T, ALLOC > boost::numeric::ublas::vector_container< scalar_vector< T, ALLOC > >::container_type [inherited]

Definition at line 281 of file expression_types.hpp.


Constructor & Destructor Documentation

template<class T , class ALLOC >
BOOST_UBLAS_INLINE boost::numeric::ublas::scalar_vector< T, ALLOC >::scalar_vector ( ) [inline]

Definition at line 1342 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE boost::numeric::ublas::scalar_vector< T, ALLOC >::scalar_vector ( size_type  size,
const value_type value = value_type(1) 
) [inline, explicit]

Definition at line 1346 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE boost::numeric::ublas::scalar_vector< T, ALLOC >::scalar_vector ( const scalar_vector< T, ALLOC > &  v) [inline]

Definition at line 1350 of file vector.hpp.


Member Function Documentation

template<class T , class ALLOC >
BOOST_UBLAS_INLINE size_type boost::numeric::ublas::scalar_vector< T, ALLOC >::size ( ) const [inline]

Definition at line 1356 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE void boost::numeric::ublas::scalar_vector< T, ALLOC >::resize ( size_type  size,
bool  = true 
) [inline]

Definition at line 1362 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_pointer boost::numeric::ublas::scalar_vector< T, ALLOC >::find_element ( size_type  ) const [inline]

Definition at line 1368 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_reference boost::numeric::ublas::scalar_vector< T, ALLOC >::operator() ( size_type  ) const [inline]

Definition at line 1374 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_reference boost::numeric::ublas::scalar_vector< T, ALLOC >::operator[] ( size_type  ) const [inline]

Definition at line 1379 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE scalar_vector& boost::numeric::ublas::scalar_vector< T, ALLOC >::operator= ( const scalar_vector< T, ALLOC > &  v) [inline]

Definition at line 1385 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE scalar_vector& boost::numeric::ublas::scalar_vector< T, ALLOC >::assign_temporary ( scalar_vector< T, ALLOC > &  v) [inline]

Definition at line 1391 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE void boost::numeric::ublas::scalar_vector< T, ALLOC >::swap ( scalar_vector< T, ALLOC > &  v) [inline]

Definition at line 1398 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_iterator boost::numeric::ublas::scalar_vector< T, ALLOC >::find ( size_type  i) const [inline]

Definition at line 1424 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_iterator boost::numeric::ublas::scalar_vector< T, ALLOC >::begin ( ) const [inline]

Definition at line 1520 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_iterator boost::numeric::ublas::scalar_vector< T, ALLOC >::end ( ) const [inline]

Definition at line 1524 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_reverse_iterator boost::numeric::ublas::scalar_vector< T, ALLOC >::rbegin ( ) const [inline]

Definition at line 1532 of file vector.hpp.

template<class T , class ALLOC >
BOOST_UBLAS_INLINE const_reverse_iterator boost::numeric::ublas::scalar_vector< T, ALLOC >::rend ( ) const [inline]

Definition at line 1536 of file vector.hpp.

template<class T , class ALLOC >
template<class Archive >
void boost::numeric::ublas::scalar_vector< T, ALLOC >::serialize ( Archive &  ar,
const unsigned  int 
) [inline]

Definition at line 1542 of file vector.hpp.

BOOST_UBLAS_INLINE const container_type& boost::numeric::ublas::vector_container< scalar_vector< T, ALLOC > >::operator() ( ) const [inline, inherited]
BOOST_UBLAS_INLINE container_type& boost::numeric::ublas::vector_container< scalar_vector< T, ALLOC > >::operator() ( ) [inline, inherited]

Friends And Related Function Documentation

template<class T , class ALLOC >
BOOST_UBLAS_INLINE friend void swap ( scalar_vector< T, ALLOC > &  v1,
scalar_vector< T, ALLOC > &  v2 
) [friend]

Definition at line 1405 of file vector.hpp.


Member Data Documentation

template<class T , class ALLOC >
size_type boost::numeric::ublas::scalar_vector< T, ALLOC >::size_ [private]

Definition at line 1552 of file vector.hpp.

template<class T , class ALLOC >
value_type boost::numeric::ublas::scalar_vector< T, ALLOC >::value_ [private]

Definition at line 1553 of file vector.hpp.

const unsigned boost::numeric::ublas::vector_container< scalar_vector< T, ALLOC > >::complexity [static, inherited]

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