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

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

A matrix with all values of type T equal to zero. More...

#include <matrix.hpp>

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

List of all members.

Classes

class  const_iterator1
class  const_iterator2

Public Types

typedef matrix_reference
< self_type
closure_type
typedef const matrix_reference
< const self_type
const_closure_type
typedef const T & const_reference
typedef reverse_iterator_base1
< const_iterator1
const_reverse_iterator1
typedef reverse_iterator_base2
< const_iterator2
const_reverse_iterator2
typedef zero_matrix< T, ALLOC > container_type
typedef ALLOC::difference_type difference_type
typedef zero_matrix< T, ALLOC > expression_type
typedef const_iterator1 iterator1
typedef const_iterator2 iterator2
typedef unknown_orientation_tag orientation_category
typedef T & reference
typedef ALLOC::size_type size_type
typedef sparse_tag storage_category
typedef matrix_tag type_category
typedef T value_type

Public Member Functions

BOOST_UBLAS_INLINE zero_matrix ()
BOOST_UBLAS_INLINE zero_matrix (size_type size)
BOOST_UBLAS_INLINE zero_matrix (const zero_matrix &m)
BOOST_UBLAS_INLINE zero_matrix (size_type size1, size_type size2)
BOOST_UBLAS_INLINE zero_matrixassign_temporary (zero_matrix &m)
BOOST_UBLAS_INLINE const_iterator1 begin1 () const
BOOST_UBLAS_INLINE const_iterator2 begin2 () const
BOOST_UBLAS_INLINE const_iterator1 end1 () const
BOOST_UBLAS_INLINE const_iterator2 end2 () const
BOOST_UBLAS_INLINE const_iterator1 find1 (int, size_type, size_type) const
BOOST_UBLAS_INLINE const_iterator2 find2 (int, size_type, size_type) const
BOOST_UBLAS_INLINE container_typeoperator() ()
BOOST_UBLAS_INLINE const_reference operator() (size_type, size_type) const
BOOST_UBLAS_INLINE const
container_type
operator() () const
BOOST_UBLAS_INLINE zero_matrixoperator= (const zero_matrix &m)
BOOST_UBLAS_INLINE
const_reverse_iterator1 
rbegin1 () const
BOOST_UBLAS_INLINE
const_reverse_iterator2 
rbegin2 () const
BOOST_UBLAS_INLINE
const_reverse_iterator1 
rend1 () const
BOOST_UBLAS_INLINE
const_reverse_iterator2 
rend2 () const
BOOST_UBLAS_INLINE void resize (size_type size, bool preserve=true)
BOOST_UBLAS_INLINE void resize (size_type size1, size_type size2, bool=true)
template<class Archive >
void serialize (Archive &ar, const unsigned int)
BOOST_UBLAS_INLINE size_type size1 () const
BOOST_UBLAS_INLINE size_type size2 () const
BOOST_UBLAS_INLINE void swap (zero_matrix &m)

Static Public Attributes

static const unsigned complexity

Private Types

typedef const T * const_pointer
typedef zero_matrix< T, ALLOC > self_type

Private Attributes

size_type size1_
size_type size2_

Static Private Attributes

static const value_type zero_ = T()

Friends

BOOST_UBLAS_INLINE friend void swap (zero_matrix &m1, zero_matrix &m2)

Detailed Description

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

A matrix with all values of type T equal to zero.

Changing values does not affect the matrix, however assigning it to a normal matrix will put zero everywhere in the target matrix. All accesses are constant time, due to the trivial value.

Template Parameters:
Tthe type of object stored in the matrix (like double, float, complex, etc...)
ALLOCan allocator for storing the zero element. By default, a standar allocator is used.

Definition at line 2177 of file matrix.hpp.


Member Typedef Documentation

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

Definition at line 2180 of file matrix.hpp.

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

Definition at line 2186 of file matrix.hpp.

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

Definition at line 2187 of file matrix.hpp.

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

Definition at line 2188 of file matrix.hpp.

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

Definition at line 2189 of file matrix.hpp.

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

Definition at line 2190 of file matrix.hpp.

template<class T, class ALLOC>
typedef const matrix_reference<const self_type> boost::numeric::ublas::zero_matrix< T, ALLOC >::const_closure_type

Definition at line 2191 of file matrix.hpp.

template<class T, class ALLOC>
typedef matrix_reference<self_type> boost::numeric::ublas::zero_matrix< T, ALLOC >::closure_type

Definition at line 2192 of file matrix.hpp.

template<class T, class ALLOC>
typedef sparse_tag boost::numeric::ublas::zero_matrix< T, ALLOC >::storage_category

Definition at line 2193 of file matrix.hpp.

template<class T, class ALLOC>
typedef unknown_orientation_tag boost::numeric::ublas::zero_matrix< T, ALLOC >::orientation_category

Definition at line 2194 of file matrix.hpp.

Definition at line 2271 of file matrix.hpp.

Definition at line 2273 of file matrix.hpp.

template<class T, class ALLOC>
typedef const_iterator1 boost::numeric::ublas::zero_matrix< T, ALLOC >::iterator1

Definition at line 2384 of file matrix.hpp.

template<class T, class ALLOC>
typedef const_iterator2 boost::numeric::ublas::zero_matrix< T, ALLOC >::iterator2

Definition at line 2494 of file matrix.hpp.

typedef zero_matrix< T, ALLOC > boost::numeric::ublas::matrix_container< zero_matrix< T, ALLOC > >::container_type [inherited]

Definition at line 488 of file expression_types.hpp.


Constructor & Destructor Documentation

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

Definition at line 2198 of file matrix.hpp.

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

Definition at line 2202 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE boost::numeric::ublas::zero_matrix< T, ALLOC >::zero_matrix ( size_type  size1,
size_type  size2 
) [inline]

Definition at line 2206 of file matrix.hpp.

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

Definition at line 2210 of file matrix.hpp.


Member Function Documentation

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

Definition at line 2216 of file matrix.hpp.

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

Definition at line 2220 of file matrix.hpp.

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

Definition at line 2226 of file matrix.hpp.

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

Definition at line 2231 of file matrix.hpp.

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

Definition at line 2238 of file matrix.hpp.

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

Definition at line 2244 of file matrix.hpp.

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

Definition at line 2250 of file matrix.hpp.

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

Definition at line 2257 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::zero_matrix< T, ALLOC >::find1 ( int  ,
size_type  ,
size_type   
) const [inline]

Definition at line 2277 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::zero_matrix< T, ALLOC >::find2 ( int  ,
size_type  ,
size_type   
) const [inline]

Definition at line 2281 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::zero_matrix< T, ALLOC >::begin1 ( ) const [inline]

Definition at line 2387 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::zero_matrix< T, ALLOC >::end1 ( ) const [inline]

Definition at line 2391 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::zero_matrix< T, ALLOC >::begin2 ( ) const [inline]

Definition at line 2497 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::zero_matrix< T, ALLOC >::end2 ( ) const [inline]

Definition at line 2501 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::zero_matrix< T, ALLOC >::rbegin1 ( ) const [inline]

Definition at line 2508 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::zero_matrix< T, ALLOC >::rend1 ( ) const [inline]

Definition at line 2512 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::zero_matrix< T, ALLOC >::rbegin2 ( ) const [inline]

Definition at line 2517 of file matrix.hpp.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::zero_matrix< T, ALLOC >::rend2 ( ) const [inline]

Definition at line 2521 of file matrix.hpp.

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

Definition at line 2527 of file matrix.hpp.

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

Friends And Related Function Documentation

template<class T, class ALLOC>
BOOST_UBLAS_INLINE friend void swap ( zero_matrix< T, ALLOC > &  m1,
zero_matrix< T, ALLOC > &  m2 
) [friend]

Definition at line 2264 of file matrix.hpp.


Member Data Documentation

template<class T, class ALLOC>
size_type boost::numeric::ublas::zero_matrix< T, ALLOC >::size1_ [private]

Definition at line 2546 of file matrix.hpp.

template<class T, class ALLOC>
size_type boost::numeric::ublas::zero_matrix< T, ALLOC >::size2_ [private]

Definition at line 2547 of file matrix.hpp.

template<class T, class ALLOC>
const zero_matrix< T, ALLOC >::value_type boost::numeric::ublas::zero_matrix< T, ALLOC >::zero_ = T() [static, private]

Definition at line 2548 of file matrix.hpp.

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

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