aimstil  5.0.5
til::SymMatrix3< T > Class Template Reference

A class to store a 3*3 symetric matrix. More...

#include <til/SymMatrix3.h>

Inheritance diagram for til::SymMatrix3< T >:
Collaboration diagram for til::SymMatrix3< T >:

Classes

class  ValueProxy
 

Public Types

typedef SymMatrix3< T > Self
 
typedef Matrix3< T > Base
 
typedef T const_reference
 
typedef const T * const_pointer
 
- Public Types inherited from til::Matrix3< T >
typedef Matrix3< T > Self
 
typedef T value_type
 
typedef boost::array< T, 3 > row_type
 
typedef boost::array< T, 3 *3 > Data
 
typedef Data::iterator iterator
 
typedef Data::const_iterator const_iterator
 

Public Member Functions

 SymMatrix3 ()
 Empty matrix full of zeros. More...
 
 SymMatrix3 (NoInit)
 No initialization. More...
 
 SymMatrix3 (T xx, T xy, T xz, T yy, T yz, T zz)
 Initialize with elements. More...
 
operator() (std::size_t i, std::size_t j) const
 get value at position (i,j). More...
 
ValueProxy operator() (std::size_t i, std::size_t j)
 get non-const access to value at position (i,j). More...
 
void set (const std::pair< std::size_t, std::size_t > &i, T value)
 Set a value to the matrix. More...
 
get (const std::pair< std::size_t, std::size_t > &i)
 
- Public Member Functions inherited from til::Matrix3< T >
 Matrix3 ()
 Empty matrix of zeros. More...
 
 Matrix3 (NoInit)
 No initialization. More...
 
 Matrix3 (T xx, T xy, T xz, T yx, T yy, T yz, T zx, T zy, T zz)
 Initialize with elements. More...
 
 ~Matrix3 ()
 
boost::array< std::size_t, 2 > dims () const
 
const T & operator() (std::size_t i, std::size_t j) const
 
T & operator() (std::size_t i, std::size_t j)
 
void reset ()
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
void operator+= (Self const &mat)
 
void operator-= (Self const &mat)
 

Detailed Description

template<typename T>
class til::SymMatrix3< T >

A class to store a 3*3 symetric matrix.

Definition at line 23 of file SymMatrix3.h.

Member Typedef Documentation

◆ Base

template<typename T>
typedef Matrix3<T> til::SymMatrix3< T >::Base

Definition at line 28 of file SymMatrix3.h.

◆ const_pointer

template<typename T>
typedef const T* til::SymMatrix3< T >::const_pointer

Definition at line 31 of file SymMatrix3.h.

◆ const_reference

template<typename T>
typedef T til::SymMatrix3< T >::const_reference

Definition at line 30 of file SymMatrix3.h.

◆ Self

template<typename T>
typedef SymMatrix3<T> til::SymMatrix3< T >::Self

Definition at line 27 of file SymMatrix3.h.

Constructor & Destructor Documentation

◆ SymMatrix3() [1/3]

template<typename T>
til::SymMatrix3< T >::SymMatrix3 ( )
inline

Empty matrix full of zeros.

Definition at line 39 of file SymMatrix3.h.

◆ SymMatrix3() [2/3]

template<typename T>
til::SymMatrix3< T >::SymMatrix3 ( NoInit  )
inline

No initialization.

Definition at line 42 of file SymMatrix3.h.

◆ SymMatrix3() [3/3]

template<typename T>
til::SymMatrix3< T >::SymMatrix3 ( xx,
xy,
xz,
yy,
yz,
zz 
)
inline

Initialize with elements.

Definition at line 45 of file SymMatrix3.h.

Member Function Documentation

◆ get()

template<typename T>
T til::SymMatrix3< T >::get ( const std::pair< std::size_t, std::size_t > &  i)
inline

Definition at line 73 of file SymMatrix3.h.

◆ operator()() [1/2]

template<typename T>
T til::SymMatrix3< T >::operator() ( std::size_t  i,
std::size_t  j 
) const
inline

get value at position (i,j).

Definition at line 58 of file SymMatrix3.h.

◆ operator()() [2/2]

template<typename T>
ValueProxy til::SymMatrix3< T >::operator() ( std::size_t  i,
std::size_t  j 
)
inline

get non-const access to value at position (i,j).

Definition at line 62 of file SymMatrix3.h.

◆ set()

template<typename T>
void til::SymMatrix3< T >::set ( const std::pair< std::size_t, std::size_t > &  i,
value 
)
inline

Set a value to the matrix.

This function is used by the value proxy

Definition at line 67 of file SymMatrix3.h.

Referenced by til::getLocalHessian().


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