Diffpack Documentation

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

Ptm(Type) Class Reference

simple matrix used for point transformations. More...

#include <Ptm_Type.h>

List of all members.

Public Methods

 Ptm(Type) ()
 Ptm(Type) (const int n)
 Ptm(Type) (const int m, const int n)
 Ptm(Type) (const Ptv(Type) &v1)
 Ptm(Type) (const Ptv(Type) &v1, const Ptv(Type) &v2)
 Ptm(Type) (const Ptv(Type) &v1, const Ptv(Type) &v2, const Ptv(Type) &v3)
 Ptm(Type) (const Ptm(Type) &T)
 ~Ptm(Type) ()
bool ok () const
void redim (int n)
void redim (int m, int n)
void redim (const Ptv(Type) &v1)
void redim (const Ptv(Type) &v1, const Ptv(Type) &v2)
void redim (const Ptv(Type) &v1, const Ptv(Type) &v2, const Ptv(Type) &v3)
void redim (const Ptm(Type) &T)
void fill (Type *value)
void fill (Type value)
void mult (Type value)
int getNoRows () const
int getNoColumns () const
int size () const
Type& operator() (int i, int j)
Type operator() (int i, int j) const
Ptv(Type)& operator() (int i)
Ptv(Type) operator() (int i) const
Type* getPtr ()
Ptm(Type)& operator= (const Type &value)
Ptm(Type)& operator= (const Ptm(Type) &T)
bool operator== (const Ptm(Type) &T) const
bool operator!= (const Ptm(Type) &T) const
bool eq (const Ptm(Type) &T, real tolerance=comparison_tolerance) const
bool neq (const Ptm(Type) &T, real tolerance=comparison_tolerance) const
Ptv(Type) operator * (const Ptv(Type) &X) const
Ptm(Type) operator * (const Ptm(Type) &T) const
void prod (Ptv(Type) &X) const
void prod (Ptv(Type) &Y, const Ptv(Type) &X, bool add_to) const
void prod (Ptm(Type) &R, const Ptm(Type) &T, bool add_to) const
void add (Type a, const Ptm(Type) &X)
void add (const Ptm(Type) &X)
void sub (const Ptm(Type) &X)
Type prod (const Ptv(Type) &X, const Ptv(Type) &Y) const
Type inner (const Ptm(Type) &T) const
real inner () const
Type trace () const
void transpose ()
void symmetric ()
void print (Os os, const char *=NULL) const

Detailed Description

simple matrix used for point transformations.

NAME: Ptm(Type) - simple matrix used for point transformations

DESCRIPTION:

The class represents a matrix that matches class "Ptv" and is used for point transformations (2x2 and 3x3 matrices) and for representing gradient tensors of vector fields (nx2 and nx3 matrices). The class has a static array hardcoded (of length "tDIM") and currently no dynamic alternative is available for larger matrices (to be added later when neccesary).

Constructor & Destructor Documentation

Ptm(Type)::Ptm_Type ( ) [inline]
 

Ptm(Type)::Ptm_Type ( const int n ) [inline]
 

Ptm(Type)::Ptm_Type ( const int m,
const int n ) [inline]
 

Ptm(Type)::Ptm_Type ( const Ptv(Type) & v1 ) [inline]
 

Ptm(Type)::Ptm_Type ( const Ptv(Type) & v1,
const Ptv(Type) & v2 ) [inline]
 

Ptm(Type)::Ptm_Type ( const Ptv(Type) & v1,
const Ptv(Type) & v2,
const Ptv(Type) & v3 ) [inline]
 

Ptm(Type)::Ptm_Type ( const Ptm(Type) & T ) [inline]
 

Ptm(Type)::~Ptm(Type) ( ) [inline]
 

Member Function Documentation

void Ptm(Type)::add ( const Ptm(Type) & X )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::add ( Type a,
const Ptm(Type) & X )
 

finds the sum of two matrices, see comments in function declarations.

bool Ptm(Type)::eq ( const Ptm(Type) & T,
real tolerance = comparison_tolerance ) const
 

void Ptm(Type)::fill ( Type value )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::fill ( Type * value )
 

fill all entries with the supplied value.

int Ptm(Type)::getNoColumns ( ) const [inline]
 

get the number of columns in the matrix

int Ptm(Type)::getNoRows ( ) const [inline]
 

get the number of rows in the matrix

Type * Ptm(Type)::getPtr ( )
 

get access to the vector holding the matrix elements.

real Ptm(Type)::inner ( ) const
 

See documentation of one of the overloaded functions.

Type Ptm(Type)::inner ( const Ptm(Type) & T ) const
 

finds the scalar product or double-dot product of two matrices, i.e. the sum of the products of the individual matrix elements.

void Ptm(Type)::mult ( Type value )
 

multiply all entries with the supplied value.

bool Ptm(Type)::neq ( const Ptm(Type) & T,
real tolerance = comparison_tolerance ) const
 

bool Ptm(Type)::ok ( ) const
 

Ptm(Type) Ptm(Type)::operator * ( const Ptm(Type) & T ) const
 

Ptv(Type) Ptm(Type)::operator * ( const Ptv(Type) & X ) const
 

bool Ptm(Type)::operator!= ( const Ptm(Type) & T ) const
 

Ptv(Type) Ptm(Type)::operator() ( int i ) const
 

Ptv(Type) & Ptm(Type)::operator() ( int i )
 

Type Ptm(Type)::operator() ( int i,
int j ) const
 

Type & Ptm(Type)::operator() ( int i,
int j )
 

Ptm(Type) & Ptm(Type)::operator= ( const Ptm(Type) & T )
 

Ptm(Type) & Ptm(Type)::operator= ( const Type & value )
 

bool Ptm(Type)::operator== ( const Ptm(Type) & T ) const
 

void Ptm(Type)::print ( Os os,
const char * = NULL ) const
 

print this matrix with the supplied heading

Type Ptm(Type)::prod ( const Ptv(Type) & X,
const Ptv(Type) & Y ) const
 

See documentation of one of the overloaded functions.

void Ptm(Type)::prod ( Ptm(Type) & R,
const Ptm(Type) & T,
bool add_to ) const
 

See documentation of one of the overloaded functions.

void Ptm(Type)::prod ( Ptv(Type) & Y,
const Ptv(Type) & X,
bool add_to ) const
 

See documentation of one of the overloaded functions.

void Ptm(Type)::prod ( Ptv(Type) & X ) const
 

performs matrix-vector and matrix-matrix multiplications. Several overloaded versions exist, see comments in function declarations.

void Ptm(Type)::redim ( const Ptm(Type) & T )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::redim ( const Ptv(Type) & v1,
const Ptv(Type) & v2,
const Ptv(Type) & v3 )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::redim ( const Ptv(Type) & v1,
const Ptv(Type) & v2 )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::redim ( const Ptv(Type) & v1 )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::redim ( int m,
int n )
 

See documentation of one of the overloaded functions.

void Ptm(Type)::redim ( int n )
 

See documentation of one of the overloaded functions.

int Ptm(Type)::size ( ) const [inline]
 

get the total number of entries in the matrix.

void Ptm(Type)::sub ( const Ptm(Type) & X )
 

finds the difference between two matrices, see comments in function declarations.

void Ptm(Type)::symmetric ( )
 

make the current matrix symmetric, that is 

      this = 0.5*(this+this^t)

Type Ptm(Type)::trace ( ) const
 

returns the sum of the diagonal elements.

void Ptm(Type)::transpose ( )
 

transpose the current matrix object.

The documentation for this class was generated from the following file:
Copyright © 2003 inuTech GmbH. All rights reserved.