OpenFPM_data  0.1.0
Project that contain the implementation and interfaces for basic structure like vectors, grids, graph ... .
 All Data Structures Namespaces Functions Variables Typedefs Friends
Matrix< dim, T > Class Template Reference

This class implement an NxN (dense) matrix. More...

Detailed Description

template<unsigned int dim, typename T>
class Matrix< dim, T >

This class implement an NxN (dense) matrix.

Be carefull when you allocate locally it take memory from the stack

Template Parameters
dimdimensionality
Ttype of the space
Warning
Matrix is untested so it remain as concept usage until test are not introduced

Definition at line 32 of file Matrix.hpp.

#include <Matrix.hpp>

Public Types

typedef T coord_type
 
typedef boost::fusion::vector
< T[dim][dim]> 
type
 boost fusion that store the point
 

Public Member Functions

get (size_t i, size_t j) const
 Get coordinate. More...
 
T & get (size_t i, size_t j)
 Get coordinate. More...
 
Matrix< dim, T > & operator= (const Matrix< dim, T > &m)
 operator= between Matrix More...
 
void zero ()
 Set to zero the point coordinate. More...
 
 Matrix (const Matrix< dim, T > &&p)
 Point constructor from point. More...
 
 Matrix (const Matrix< dim, T > &p)
 Point constructor from point. More...
 
 Matrix (const T(&p)[dim][dim])
 Constructor from an array. More...
 
 Matrix (grid_key_dx< dim > key)
 Constructor from a grid_key_dx<dim> More...
 
 Matrix (std::initializer_list< T > p1)
 Constructor from a list. More...
 
 Matrix ()
 Default contructor.
 

Static Public Member Functions

static Matrix< dim, T > identity ()
 Identity matrix. More...
 

Data Fields

type data
 structure that store the data of the point
 

Static Public Attributes

static const unsigned int mat = 0
 Property id of the point.
 
static const unsigned int max_prop = 1
 
static const unsigned int dims = dim
 

Constructor & Destructor Documentation

template<unsigned int dim, typename T>
Matrix< dim, T >::Matrix ( const Matrix< dim, T > &&  p)
inline

Point constructor from point.

Parameters
pthe point

Definition at line 109 of file Matrix.hpp.

template<unsigned int dim, typename T>
Matrix< dim, T >::Matrix ( const Matrix< dim, T > &  p)
inline

Point constructor from point.

Parameters
pthe point

Definition at line 125 of file Matrix.hpp.

template<unsigned int dim, typename T>
Matrix< dim, T >::Matrix ( const T(&)  p[dim][dim])
inline

Constructor from an array.

Parameters
parray with the coordinate of the point

Definition at line 136 of file Matrix.hpp.

template<unsigned int dim, typename T>
Matrix< dim, T >::Matrix ( grid_key_dx< dim >  key)
inline

Constructor from a grid_key_dx<dim>

Parameters
keyfrom where to initialize

Definition at line 147 of file Matrix.hpp.

template<unsigned int dim, typename T>
Matrix< dim, T >::Matrix ( std::initializer_list< T >  p1)
inline

Constructor from a list.

[Example] Point<3,float> p({0.0,0.0,1.0})

Definition at line 158 of file Matrix.hpp.

Member Function Documentation

template<unsigned int dim, typename T>
T Matrix< dim, T >::get ( size_t  i,
size_t  j 
) const
inline

Get coordinate.

Parameters
irow
jcolums
Returns
the matrix element

Definition at line 55 of file Matrix.hpp.

template<unsigned int dim, typename T>
T& Matrix< dim, T >::get ( size_t  i,
size_t  j 
)
inline

Get coordinate.

Parameters
irow
jcolum
Returns
the value

Definition at line 68 of file Matrix.hpp.

template<unsigned int dim, typename T>
static Matrix<dim,T> Matrix< dim, T >::identity ( )
inlinestatic

Identity matrix.

Return the identity matrix

Definition at line 174 of file Matrix.hpp.

template<unsigned int dim, typename T>
Matrix<dim,T>& Matrix< dim, T >::operator= ( const Matrix< dim, T > &  m)
inline

operator= between Matrix

Parameters
mMatrix

Definition at line 78 of file Matrix.hpp.

template<unsigned int dim, typename T>
void Matrix< dim, T >::zero ( )
inline

Set to zero the point coordinate.

Definition at line 93 of file Matrix.hpp.


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