Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
boost::numeric::ublas::identity_matrix< T, ALLOC > Class Template Reference

An identity matrix with values of type T. More...

#include <matrix.hpp>

Inheritance diagram for boost::numeric::ublas::identity_matrix< T, ALLOC >:
Inheritance graph
[legend]
Collaboration diagram for boost::numeric::ublas::identity_matrix< T, ALLOC >:
Collaboration graph
[legend]

Classes

class  const_iterator1
 
class  const_iterator2
 

Public Types

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

Public Member Functions

BOOST_UBLAS_INLINE identity_matrix ()
 
BOOST_UBLAS_INLINE identity_matrix (size_type size)
 
BOOST_UBLAS_INLINE identity_matrix (size_type size1, size_type size2)
 
BOOST_UBLAS_INLINE identity_matrix (const identity_matrix &m)
 
BOOST_UBLAS_INLINE size_type size1 () const
 
BOOST_UBLAS_INLINE size_type size2 () const
 
BOOST_UBLAS_INLINE void resize (size_type size, bool=true)
 
BOOST_UBLAS_INLINE void resize (size_type size1, size_type size2, bool=true)
 
BOOST_UBLAS_INLINE const_reference operator() (size_type i, size_type j) const
 
BOOST_UBLAS_INLINE
identity_matrix & 		operator= (const identity_matrix &m)
 
BOOST_UBLAS_INLINE
identity_matrix & 		assign_temporary (identity_matrix &m)
 
BOOST_UBLAS_INLINE void swap (identity_matrix &m)
 
BOOST_UBLAS_INLINE const_iterator1 find1 (int rank, size_type i, size_type j) const
 
BOOST_UBLAS_INLINE const_iterator2 find2 (int rank, size_type i, size_type j) const
 
BOOST_UBLAS_INLINE const_iterator1 begin1 () const
 
BOOST_UBLAS_INLINE const_iterator1 cbegin1 () const
 
BOOST_UBLAS_INLINE const_iterator1 end1 () const
 
BOOST_UBLAS_INLINE const_iterator1 cend1 () const
 
BOOST_UBLAS_INLINE const_iterator2 begin2 () const
 
BOOST_UBLAS_INLINE const_iterator2 cbegin2 () const
 
BOOST_UBLAS_INLINE const_iterator2 end2 () const
 
BOOST_UBLAS_INLINE const_iterator2 cend2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 		rbegin1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 		crbegin1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 		rend1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator1 		crend1 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 		rbegin2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 		crbegin2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 		rend2 () const
 
BOOST_UBLAS_INLINE
const_reverse_iterator2 		crend2 () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 
BOOST_UBLAS_INLINE const
container_type & 		operator() () const
 
BOOST_UBLAS_INLINE container_type & operator() ()
 

Static Public Attributes

static const unsigned complexity
 

Friends

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

Detailed Description

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

An identity matrix with values of type T.

Elements or cordinates $(i,i)$ are equal to 1 (one) and all others to 0 (zero). Changing values does not affect the matrix, however assigning it to a normal matrix will make the matrix equal to an identity matrix. All accesses are constant du to the trivial values.

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

Member Typedef Documentation

template<class T, class ALLOC>
typedef matrix_reference<self_type> boost::numeric::ublas::identity_matrix< T, ALLOC >::closure_type
template<class T, class ALLOC>
typedef const matrix_reference<const self_type> boost::numeric::ublas::identity_matrix< T, ALLOC >::const_closure_type
template<class T, class ALLOC>
typedef const T& boost::numeric::ublas::identity_matrix< T, ALLOC >::const_reference
template<class T, class ALLOC>
typedef reverse_iterator_base1<const_iterator1> boost::numeric::ublas::identity_matrix< T, ALLOC >::const_reverse_iterator1
template<class T, class ALLOC>
typedef reverse_iterator_base2<const_iterator2> boost::numeric::ublas::identity_matrix< T, ALLOC >::const_reverse_iterator2
typedef identity_matrix< T, ALLOC > boost::numeric::ublas::matrix_container< identity_matrix< T, ALLOC > >::container_type
inherited
template<class T, class ALLOC>
typedef ALLOC::difference_type boost::numeric::ublas::identity_matrix< T, ALLOC >::difference_type
template<class E>
typedef E boost::numeric::ublas::matrix_expression< E >::expression_type
inherited
template<class T, class ALLOC>
typedef const_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::iterator1
template<class T, class ALLOC>
typedef const_iterator2 boost::numeric::ublas::identity_matrix< T, ALLOC >::iterator2
template<class T, class ALLOC>
typedef unknown_orientation_tag boost::numeric::ublas::identity_matrix< T, ALLOC >::orientation_category
template<class T, class ALLOC>
typedef T& boost::numeric::ublas::identity_matrix< T, ALLOC >::reference
template<class T, class ALLOC>
typedef ALLOC::size_type boost::numeric::ublas::identity_matrix< T, ALLOC >::size_type
template<class T, class ALLOC>
typedef sparse_tag boost::numeric::ublas::identity_matrix< T, ALLOC >::storage_category
typedef matrix_tag boost::numeric::ublas::matrix_container< identity_matrix< T, ALLOC > >::type_category
inherited
template<class T, class ALLOC>
typedef T boost::numeric::ublas::identity_matrix< T, ALLOC >::value_type

Constructor & Destructor Documentation

template<class T, class ALLOC>
BOOST_UBLAS_INLINE boost::numeric::ublas::identity_matrix< T, ALLOC >::identity_matrix ( )
inline
template<class T, class ALLOC>
BOOST_UBLAS_INLINE boost::numeric::ublas::identity_matrix< T, ALLOC >::identity_matrix ( size_type  size)
inline
template<class T, class ALLOC>
BOOST_UBLAS_INLINE boost::numeric::ublas::identity_matrix< T, ALLOC >::identity_matrix ( size_type  size1,
size_type  size2 
)
inline
template<class T, class ALLOC>
BOOST_UBLAS_INLINE boost::numeric::ublas::identity_matrix< T, ALLOC >::identity_matrix ( const identity_matrix< T, ALLOC > &  m)
inline

Member Function Documentation

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

References boost::numeric::ublas::identity_matrix< T, ALLOC >::swap().

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

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::cbegin1(), and boost::numeric::ublas::identity_matrix< T, ALLOC >::rend1().

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

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::cbegin2(), and boost::numeric::ublas::identity_matrix< T, ALLOC >::rend2().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::cbegin1 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::begin1().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::identity_matrix< T, ALLOC >::cbegin2 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::begin2().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::cend1 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::end1().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::identity_matrix< T, ALLOC >::cend2 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::end2().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::crbegin1 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::rbegin1().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::identity_matrix< T, ALLOC >::crbegin2 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::rbegin2().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::crend1 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::rend1().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator2 boost::numeric::ublas::identity_matrix< T, ALLOC >::crend2 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::rend2().

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

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::cend1(), and boost::numeric::ublas::identity_matrix< T, ALLOC >::rbegin1().

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

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::cend2(), and boost::numeric::ublas::identity_matrix< T, ALLOC >::rbegin2().

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::find1 ( int  rank,
size_type  i,
size_type  j 
) const
inline

References boost::accumulators::extract::max, and boost::accumulators::extract::min.

template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_iterator2 boost::numeric::ublas::identity_matrix< T, ALLOC >::find2 ( int  rank,
size_type  i,
size_type  j 
) const
inline

References boost::accumulators::extract::max, and boost::accumulators::extract::min.

BOOST_UBLAS_INLINE const container_type& boost::numeric::ublas::matrix_container< identity_matrix< T, ALLOC > >::operator() ( ) const
inlineinherited
BOOST_UBLAS_INLINE container_type& boost::numeric::ublas::matrix_container< identity_matrix< T, ALLOC > >::operator() ( )
inlineinherited
template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reference boost::numeric::ublas::identity_matrix< T, ALLOC >::operator() ( size_type  i,
size_type  j 
) const
inline
template<class T, class ALLOC>
BOOST_UBLAS_INLINE identity_matrix& boost::numeric::ublas::identity_matrix< T, ALLOC >::operator= ( const identity_matrix< T, ALLOC > &  m)
inline
template<class T, class ALLOC>
BOOST_UBLAS_INLINE const_reverse_iterator1 boost::numeric::ublas::identity_matrix< T, ALLOC >::rbegin1 ( ) const
inline

References boost::numeric::ublas::identity_matrix< T, ALLOC >::end1().

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::crbegin1().

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

References boost::numeric::ublas::identity_matrix< T, ALLOC >::end2().

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::crbegin2().

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

References boost::numeric::ublas::identity_matrix< T, ALLOC >::begin1().

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::crend1().

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

References boost::numeric::ublas::identity_matrix< T, ALLOC >::begin2().

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::crend2().

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

References boost::accumulators::extract::min, and boost::numeric::ublas::size().

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

References boost::accumulators::extract::min, boost::numeric::ublas::identity_matrix< T, ALLOC >::size1(), and boost::numeric::ublas::identity_matrix< T, ALLOC >::size2().

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

References boost::serialization::make_nvp(), boost::accumulators::extract::min, boost::xpressive::s1, boost::xpressive::s2, and boost::program_options::value().

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

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::const_iterator1::operator++(), and boost::numeric::ublas::identity_matrix< T, ALLOC >::resize().

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

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::resize().

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

References boost::swap.

Referenced by boost::numeric::ublas::identity_matrix< T, ALLOC >::assign_temporary().

Friends And Related Function Documentation

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

Member Data Documentation

const unsigned boost::numeric::ublas::matrix_container< identity_matrix< T, ALLOC > >::complexity
staticinherited
The documentation for this class was generated from the following files: