Itasca C++ Interface
Public Member Functions | Related Functions | List of all members
DMatrix< SX, SY > Class Template Reference

DMatrix is a Matrix that defaults to type double... More...

#include <matrix.h>

Inheritance diagram for DMatrix< SX, SY >:
Matrix< double, SX, SX >

Public Member Functions

constexpr DMatrix ()
 Default constructor, no data initialization.
 
constexpr DMatrix (const DMatrix< SX, SY > &m)
 Copy constructor.
 
constexpr DMatrix (const Matrix< double, SX, SY > &m)
 Copy constructor, for Matrix.
 
constexpr const DMatrix< SX, SY > & operator= (const DMatrix< SX, SY > &m)
 Equality operator.
 
- Public Member Functions inherited from Matrix< double, SX, SX >
PUSHWARNING VSWARNING (26495) Matrix()
 Default constructor, does nothing and no initialization.
 
constexpr POPWARNING Matrix (const double &t)
 Explicit constructor, initializes all elements to value t.
 
constexpr Matrix (const std::array< std::array< double, SY >, SX > &a)
 
constexpr Matrix (const std::initializer_list< std::initializer_list< double >> l)
 
constexpr Matrix (const Matrix< double, SX, SY > &m)
 Copy constructor.
 
constexpr const Matrix< double, SX, SY > & operator= (const Matrix< double, SX, SY > &m)
 Equality operator.
 
constexpr const double & get (unsigned x, unsigned y) const
 Retrieve value at row x column y. Bounds checking is done in a debug compile.
 
constexpr double & get (unsigned x, unsigned y)
 Retrieve value at row x column y. Bounds checking is done in a debug compile.
 
constexpr const Column operator[] (unsigned y) const
 Array access operator returns a Column helper class, which has it's own [] operator to access a column of the row.
 
constexpr Column operator[] (unsigned y)
 Array access operator returns a Column helper class, which has it's own [] operator to access a column of the row.
 
constexpr const double & operator() (unsigned x, unsigned y) const
 () operator access to get(x,y)
 
constexpr double & operator() (unsigned x, unsigned y)
 () operator access to get(x,y)
 
constexpr const Matrix< double, SX, SY > & operator+= (const Matrix< double, SX, SY > &m)
 In-place matrix addition.
 
constexpr const Matrix< double, SX, SY > & operator-= (const Matrix< double, SX, SY > &m)
 In-place matrix subtraction.
 
constexpr const Matrix< double, SX, SY > & operator*= (const double &t)
 In-place multiplication by a scalar.
 
constexpr const Matrix< double, SX, SY > & operator/= (const double &t)
 In-place division by a scalar.
 
Matrix< double, SX, SY > operator+ (const Matrix< double, SX, SY > &m) const
 Binary addition operator.
 
Matrix< double, SX, SY > operator- (const Matrix< double, SX, SY > &m) const
 Binary subtraction operator.
 
Matrix< double, SX, SY > operator* (const double &t) const
 Binary scalar multiplication operator.
 
Matrix< double, SX, SZ > operator* (const Matrix< double, SY, SZ > &m) const
 Binary matrix multiplication operator – simplest naive approach.
 
Matrix< double, SX, SY > operator/ (const double &t) const
 Binary scalar division operator.
 
void addBlock (const Matrix< double, SX2, SY2 > &m, unsigned iSrc, unsigned jSrc, unsigned iDst, unsigned jDst)
 Adds a block to this matrix from matrix m using the block size (BX,BY), from block indices (iSrc,jSrc) to block indices (iDst,jDst)
 
void addGenBlock (const Matrix< double, SX2, SY2 > &m, unsigned iSrc, unsigned jSrc, unsigned iDst, unsigned jDst)
 Adds a block to this matrix from matrix m using the block size (BX,BY), from normal not block indices (iSrc,jSrc) to (iDst,jDst)
 
double maxNorm () const
 Returns the infinity norm of the matrix, or the maximum absolute magnitude of any element.
 
Matrix< double, SY, SX > transpose () const
 Return the transpose of the matrix.
 
double trace () const
 Return the trace of the matrix or the sum of the diagonal components. Works also if the matrix is not square.
 
constexpr void set (const double &t=double())
 Set all entries in the matrix to t.
 

Related Functions

(Note that these are not member functions.)

template<unsigned SX>
DSymMatrix< SX > toSymMatrix (const SymTensor &s)
 
BASE_EXPORT DMatrix< 3, 3 > toMatrix (const SymTensor &s)
 
BASE_EXPORT DMatrix< 2, 2 > toMatrix2 (const SymTensor &s)
 
SymTensor toSymTensor (const DMatrix< 3, 3 > &m)
 

Additional Inherited Members

- Static Public Member Functions inherited from Matrix< double, SX, SX >
static constexpr Matrix< double, SX, SY > identity ()
 Returns an identity matrix (or as close as you can get if not diagonal).
 
- Public Attributes inherited from Matrix< double, SX, SX >
double t_ [SX][SY]
 

Detailed Description

template<unsigned SX, unsigned SY = SX>
class DMatrix< SX, SY >

DMatrix is a Matrix that defaults to type double...


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