tmath::MatrixCWise Class Reference

coefficient wise access to Matrix More...

#include <matrix_cw.hpp>

Inheritance diagram for tmath::MatrixCWise:

Inheritance graph
[legend]
Collaboration diagram for tmath::MatrixCWise:

Collaboration graph
[legend]

List of all members.

Public Types

typedef Eigen::Matrix< TScalar,
Eigen::Dynamic, Eigen::Dynamic,
Eigen::ColMajor > 
Base
typedef TScalar * TBuffer
typedef int TIndex
typedef double TScalar

Public Member Functions

Base __add__ (const TScalar &other) const
 returns a matrix expression of the coefficient-wise sum of *this and other
Base __div__ (const Base &other) const
 returns a matrix expression of the coefficient-wise division of *this and other
Base __eq__ (const TScalar &x) const
Base __eq__ (const Base &other) const
 returns a matrix expression of the coefficient-wise operator == (equal) of *this and other
Base __le__ (const TScalar &x) const
Base __le__ (const Base &other) const
 returns a matrix expression of the coefficient-wise operator <= of *this and other
Base __lt__ (const TScalar &x) const
Base __lt__ (const Base &other) const
 returns a matrix expression of the coefficient-wise operator < of *this and other
Base __mul__ (const Base &other) const
 returns a matrix expression of the coefficient-wise product of *this and other
Base __pow__ (const TScalar &exponent) const
 returns a matrix object with coefficient-wise power of *this to the given exponent (operator ^)
Base __sub__ (const TScalar &other) const
 returns a matrix expression of the coefficient-wise difference of *this and other
Base Abs () const
 returns a matrix object with coefficient-wise absolute value
Base Abs2 () const
 returns a matrix object with coefficient-wise squared absolute value
Base & Add (const TScalar &other)
 modifies this matrix by the coefficient-wise sum of *this and other
Base Atan2 (const Base &y) const
Base Cos () const
 returns a matrix object with coefficient-wise cosine
Base Cos (const TScalar &a) const
 returns a matrix object with coefficient-wise cosine of (this*a)
Base Cube () const
 returns a matrix object with coefficient-wise cubic value (x^3)
Base & Div (const Base &other)
 modifies this matrix by the coefficient-wise division of *this and other
Base Exp () const
 returns a matrix object with coefficient-wise exponential (Euler number power component)
Base Exp (const TScalar &a) const
 returns a matrix object with coefficient-wise exponential of (this*a)
Base Greater (const TScalar &x) const
 returns a matrix indicating which element of this is >x
Base Inverse () const
 returns a matrix object with coefficient-wise inverse
Base Less (const TScalar &x) const
 returns a matrix indicating which element of this is smaller than x
Base Log () const
 returns a matrix object with coefficient-wise natural logarithm
 MatrixCWise (Matrix &x)
 constructor from Matrix
 MatrixCWise (const MatrixCWise &ar)
 copy constructor
Base Max (const TScalar &z) const
 returns an array with elementwise maximum of max(this,z)
Base Max (const Base &other) const
 returns a matrix expression of the coefficient-wise operator max of *this and other
Base Min (const TScalar &z) const
 returns an array with elementwise minimum of min(this,z)
Base Min (const Base &other) const
 returns a matrix expression of the coefficient-wise operator min of *this and other
Base & Mul (const Base &other)
 modifes this matrix by the coefficient-wise product of *this and other
Base NotEqual (const TScalar &x) const
Base NotEqual (const Base &other) const
 returns a matrix expression of the coefficient-wise operator != (inequal) of *this and other
MatrixCWiseoperator= (MatrixCWise &ar)
 Sets the cwise object to an expression of another matrix.
Base Pow (const TScalar &exponent) const
 returns a matrix object with coefficient-wise power of *this to the given exponent (operator ^)
Base Sign () const
 returns an array with elementwise sign (-1 if <0, 0 if=0, 1 if>0)
Base Sin () const
 returns a matrix object with coefficient-wise sinus
Base Sin (const TScalar &a) const
 returns a matrix object with coefficient-wise sinus of (this*a)
Base Sqrt () const
 returns a matrix object with coefficient-wise square root
Base Square () const
 returns a matrix object with coefficient-wise squared value
Base & Sub (const TScalar &other)
 modifies this matrix by the coefficient-wise difference of *this and other
virtual ~MatrixCWise ()
 destructor

Protected Member Functions

const Base & base () const
Base & base ()
const Matrixmatrix () const
Matrixmatrix ()

Protected Attributes

Base * m_base
 a reference to the linked matrix (as Eigen2 object);
Matrixm_matrix
 a reference to the linked matrix;


Detailed Description

coefficient wise access to Matrix

This class provides operators and functions for coefficient wise access for matrices, i.e. it provides a scalar view on all matrix elements.

Operators cover elementwise scalar operations. Functions cover a wide field of scalar functions applied to all elements.

By using a reference counting system it is guaranteed that the refered object will not be deleted before the MatrixCWise is deleted.


Member Function Documentation

Base tmath::MatrixCWise::Atan2 ( const Base &  y  )  const

returns the arcus tangens from two parameters: x is this array, y is the given array The output object contains the elementwise atan2 values


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

Generated on Wed Nov 17 17:36:01 2010 for 'tmath' Module Programming Interface by  doxygen 1.5.6