HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T > Class Template Reference

#include <Mat.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >:

Public Types

enum  SIZE_ { size = SIZE }
 
typedef T value_type
 
typedef T ValueType
 

Public Member Functions

 Mat ()
 
 Mat (Mat const &src)
 Copy constructor. Used when the class signature matches exactly. More...
 
Matoperator= (Mat const &src)
 
std::string str (unsigned indentation=0) const
 
void write (std::ostream &os) const
 
void read (std::istream &is)
 
absMax () const
 Return the maximum of the absolute of all elements in this matrix. More...
 

Static Public Member Functions

static unsigned numRows ()
 
static unsigned numColumns ()
 
static unsigned numElements ()
 

Protected Attributes

mm [SIZE *SIZE]
 

Friends

std::ostream & operator<< (std::ostream &ostr, const Mat< SIZE, T > &m)
 Write a Mat to an output stream. More...
 

Detailed Description

template<unsigned SIZE, typename T>
class openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >

A base class for square matrices.

Definition at line 52 of file Mat.h.

Member Typedef Documentation

template<unsigned SIZE, typename T>
typedef T openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::value_type

Definition at line 55 of file Mat.h.

template<unsigned SIZE, typename T>
typedef T openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::ValueType

Definition at line 56 of file Mat.h.

Member Enumeration Documentation

template<unsigned SIZE, typename T>
enum openvdb::OPENVDB_VERSION_NAME::math::Mat::SIZE_
Enumerator
size 

Definition at line 57 of file Mat.h.

Constructor & Destructor Documentation

template<unsigned SIZE, typename T>
openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::Mat ( )
inline

Default ctor. Does nothing. Required because declaring a copy (or other) constructor means the default constructor gets left out.

Definition at line 66 of file Mat.h.

template<unsigned SIZE, typename T>
openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::Mat ( Mat< SIZE, T > const src)
inline

Copy constructor. Used when the class signature matches exactly.

Definition at line 69 of file Mat.h.

Member Function Documentation

template<unsigned SIZE, typename T>
T openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::absMax ( ) const
inline

Return the maximum of the absolute of all elements in this matrix.

Definition at line 149 of file Mat.h.

template<unsigned SIZE, typename T>
static unsigned openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::numColumns ( )
inlinestatic

Definition at line 61 of file Mat.h.

template<unsigned SIZE, typename T>
static unsigned openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::numElements ( )
inlinestatic

Definition at line 62 of file Mat.h.

template<unsigned SIZE, typename T>
static unsigned openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::numRows ( )
inlinestatic

Definition at line 60 of file Mat.h.

template<unsigned SIZE, typename T>
Mat& openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::operator= ( Mat< SIZE, T > const src)
inline

Definition at line 75 of file Mat.h.

template<unsigned SIZE, typename T>
void openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::read ( std::istream &  is)
inline

Definition at line 144 of file Mat.h.

template<unsigned SIZE, typename T>
std::string openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::str ( unsigned  indentation = 0) const
inline
Returns
string representation of matrix Since output is multiline, optional indentation argument prefixes each newline with that much white space. It does not indent the first line, since you might be calling this inline:

cout << "matrix: " << mat.str(7)

matrix: [[1 2] [3 4]]

Definition at line 94 of file Mat.h.

template<unsigned SIZE, typename T>
void openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::write ( std::ostream &  os) const
inline

Definition at line 140 of file Mat.h.

Friends And Related Function Documentation

template<unsigned SIZE, typename T>
std::ostream& operator<< ( std::ostream &  ostr,
const Mat< SIZE, T > &  m 
)
friend

Write a Mat to an output stream.

Definition at line 132 of file Mat.h.

Member Data Documentation

template<unsigned SIZE, typename T>
T openvdb::OPENVDB_VERSION_NAME::math::Mat< SIZE, T >::mm[SIZE *SIZE]
protected

Definition at line 157 of file Mat.h.


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