JMATH::JMatrixND Class Reference

N x N matrix. More...

#include <JMatrixND.hh>

Inheritance diagram for JMATH::JMatrixND:

Classes
struct	JMatrixHelper
	Auxiliary class for matrix decomposition. More...

Public Types
typedef std::vector < std::vector< double > >	matrix_type
typedef matrix_type::const_iterator	const_row_type
typedef std::vector< double > ::const_iterator	const_col_type
typedef matrix_type::iterator	row_type
typedef std::vector< double > ::iterator	col_type

Public Member Functions
	JMatrixND ()
	Default constructor. More...
	JMatrixND (const size_t size)
	Constructor. More...
void	resize (const size_t size)
	Resize matrix. More...
double	at (size_t row, size_t col) const
	Get matrix element. More...
double &	at (size_t row, size_t col)
	Get matrix element. More...
double	operator() (size_t row, size_t col) const
	Get matrix element. More...
double &	operator() (size_t row, size_t col)
	Get matrix element. More...
JMatrixND &	reset ()
	Set matrix to the null matrix. More...
JMatrixND &	setIdentity ()
	Set to identity matrix. More...
JMatrixND &	transpose ()
	Transpose. More...
JMatrixND &	negate ()
	Negate matrix. More...
JMatrixND &	add (const JMatrixND &A)
	Matrix addition. More...
JMatrixND &	sub (const JMatrixND &A)
	Matrix subtraction. More...
JMatrixND &	mul (const double factor)
	Scale matrix. More...
JMatrixND &	div (const double factor)
	Scale matrix. More...
JMatrixND &	mul (const JMatrixND &A, const JMatrixND &B)
	Matrix multiplication. More...
bool	equals (const JMatrixND &A, const double eps=std::numeric_limits< double >::min()) const
	Equality. More...
bool	isIdentity (const double eps=std::numeric_limits< double >::min()) const
	Test identity. More...
double	getDeterminant () const
	Get determinant of matrix. More...
bool	isPositiveDefinite () const
	Test positive definiteness. More...
const bool	isPositiveSemiDefinite () const
	Test positive semi-definiteness. More...
JMatrixND &	mul (const JNullType &object)
	Multiply with object. More...

Friends
JReader &	operator>> (JReader &in, JMatrixND &matrix)
	Read matrix from input. More...
JWriter &	operator<< (JWriter &out, const JMatrixND &matrix)
	Write matrix to output. More...
std::ostream &	operator<< (std::ostream &out, const JMatrixND &A)
	Print ASCII formatted output. More...

Detailed Description

N x N matrix.

Definition at line 63 of file JMatrixND.hh.

Member Typedef Documentation

typedef std::vector< std::vector<double> > JMATH::JMatrixND_t::matrix_type

inherited

Definition at line 44 of file JMatrixND.hh.

typedef matrix_type::const_iterator JMATH::JMatrixND_t::const_row_type

inherited

Definition at line 46 of file JMatrixND.hh.

typedef std::vector<double>::const_iterator JMATH::JMatrixND_t::const_col_type

inherited

Definition at line 47 of file JMatrixND.hh.

typedef matrix_type::iterator JMATH::JMatrixND_t::row_type

inherited

Definition at line 49 of file JMatrixND.hh.

typedef std::vector<double>::iterator JMATH::JMatrixND_t::col_type

inherited

Definition at line 50 of file JMatrixND.hh.

Constructor & Destructor Documentation

JMATH::JMatrixND::JMatrixND ( )

inline

Default constructor.

Definition at line 76 of file JMatrixND.hh.

    {}

JMATH::JMatrixND::JMatrixND ( const size_t  size )

inline

Constructor.

Parameters

size

dimension

Definition at line 85 of file JMatrixND.hh.

    {
      resize(size);
      reset();
    }

Member Function Documentation

void JMATH::JMatrixND::resize ( const size_t  size )

inline

Resize matrix.

Note that this method resets the matrix.

Parameters

size

dimension

Definition at line 98 of file JMatrixND.hh.

    {
      matrix_type::resize(size);

      for (row_type row = this->begin(); row != this->end(); ++row) {

        row->resize(size);

        for (col_type col = row->begin(); col != row->end(); ++col) {
          *col = 0.0;
        }
      }
    }

double JMATH::JMatrixND::at ( size_t  row, size_t  col  ) const

inline

Get matrix element.

Parameters

row	row number
col	column number

Returns

matrix element at (row,col)

Definition at line 120 of file JMatrixND.hh.

    {
      return (*this)[row][col];
    }

double& JMATH::JMatrixND::at ( size_t  row, size_t  col  )

inline

Get matrix element.

Parameters

row	row number
col	column number

Returns

matrix element at (row,col)

Definition at line 133 of file JMatrixND.hh.

    {
      return (*this)[row][col];
    }

double JMATH::JMatrixND::operator() ( size_t  row, size_t  col  ) const

inline

Get matrix element.

Parameters

row	row number
col	column number

Returns

matrix element at (row,col)

Definition at line 146 of file JMatrixND.hh.

    {
      return at(row, col);
    }

double& JMATH::JMatrixND::operator() ( size_t  row, size_t  col  )

inline

Get matrix element.

Parameters

row	row number
col	column number

Returns

matrix element at (row,col)

Definition at line 159 of file JMatrixND.hh.

    {
      return at(row, col);
    }

JMatrixND& JMATH::JMatrixND::reset ( )

inline

Set matrix to the null matrix.

Returns

this matrix

Definition at line 170 of file JMatrixND.hh.

    {
      for (row_type row = this->begin(); row != this->end(); ++row) {
        for (col_type col = row->begin(); col != row->end(); ++col) {
          *col = 0.0;
        }
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::setIdentity ( )

inline

Set to identity matrix.

Returns

this matrix

Definition at line 187 of file JMatrixND.hh.

    {
      for (size_t i = 0; i != this->size(); ++i) {

        at(i,i) = 1.0;

        for (size_t j = 0; j != i; ++j) {
          at(i,j) = at(j,i) = 0.0;
        }
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::transpose ( )

inline

Transpose.

Returns

this matrix

Definition at line 207 of file JMatrixND.hh.

    {
      for (size_t i = 0; i != this->size(); ++i) {
        for (size_t j = 0; j != i; ++j) {
          std::swap(at(i,j), at(j,i));
        }
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::negate ( )

inline

Negate matrix.

Returns

this matrix

Definition at line 224 of file JMatrixND.hh.

    {
      for (row_type row = this->begin(); row != this->end(); ++row) {
        for (col_type col = row->begin(); col != row->end(); ++col) {
          *col = -*col;
        }
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::add ( const JMatrixND &  A )

inline

Matrix addition.

Parameters

A

matrix

Returns

this matrix

Definition at line 242 of file JMatrixND.hh.

    {
      if (this->size() == A.size()) {

        for (size_t i = 0; i != this->size(); ++i) {
          for (size_t j = 0; j != this->size(); ++j) {
            at(i,j) += A.at(i,j);
          }
        }

      } else {
        THROW(JException, "JMatrixND::add() inconsistent matrix dimensions " << this->size() << ' ' << A.size());
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::sub ( const JMatrixND &  A )

inline

Matrix subtraction.

Parameters

A

matrix

Returns

this matrix

Definition at line 266 of file JMatrixND.hh.

    {
      if (this->size() == A.size()) {

        for (size_t i = 0; i != this->size(); ++i) {
          for (size_t j = 0; j != this->size(); ++j) {
            at(i,j) -= A.at(i,j);
          }
        }

      } else {
        THROW(JException, "JMatrixND::sub() inconsistent matrix dimensions " << this->size() << ' ' << A.size());
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::mul ( const double  factor )

inline

Scale matrix.

Parameters

factor

factor

Returns

this matrix

Definition at line 290 of file JMatrixND.hh.

    {
      for (row_type row = this->begin(); row != this->end(); ++row) {
        for (col_type col = row->begin(); col != row->end(); ++col) {
          *col *= factor;
        }
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::div ( const double  factor )

inline

Scale matrix.

Parameters

factor

factor

Returns

this matrix

Definition at line 308 of file JMatrixND.hh.

    {
      for (row_type row = this->begin(); row != this->end(); ++row) {
        for (col_type col = row->begin(); col != row->end(); ++col) {
          *col /= factor;
        }
      }

      return *this;
    }

JMatrixND& JMATH::JMatrixND::mul ( const JMatrixND &  A, const JMatrixND &  B  )

inline

Matrix multiplication.

Parameters

A	matrix
B	matrix

Returns

this matrix

Definition at line 327 of file JMatrixND.hh.

    {
      if (A.size() == B.size()) {
        
        this->resize(A.size());
        
        for (size_t i = 0; i != A.size(); ++i) {
          for (size_t j = 0; j != A.size(); ++j) {
            
            this->at(i,j) = 0.0;
            
            for (size_t k = 0; k != A.size(); ++k) {
              this->at(i,j) += A[i][k] * B[k][j];
            }
          }
        }
        
      } else {

        THROW(JException, "JMatrixND::mul() inconsistent matrix dimensions " << A.size() << ' ' << B.size());
      }
      
      return *this;
    }

bool JMATH::JMatrixND::equals ( const JMatrixND &  A, const double  eps = std::numeric_limits<double>::min()  ) const

inline

Equality.

Parameters

A	matrix
eps	numerical precision

Returns

true if matrices identical; else false

Definition at line 361 of file JMatrixND.hh.

    {
      if (this->size() == A.size()) {

        for (const_row_type row1 = this->begin(), row2 = A.begin(); row1 != this->end(); ++row1, ++row2) {
          for (const_col_type col1 = row1->begin(), col2 = row2->begin(); col1 != row1->end(); ++col1, ++col2) {
            if (fabs(*col1 - *col2) > eps) {
              return false;
            }
          }
        }

        return true;

      } else {
        THROW(JException, "JMatrixND::equals() inconsistent matrix dimensions " << this->size() << ' ' << A.size());
      }
    }

bool JMATH::JMatrixND::isIdentity ( const double  eps = std::numeric_limits<double>::min() ) const

inline

Test identity.

Parameters

eps	numerical precision

Returns

true if identity matrix; else false

Definition at line 388 of file JMatrixND.hh.

    {
      for (size_t i = 0; i != this->size(); ++i) {

        if (fabs(1.0 - at(i,i)) > eps) {
          return false;
        };
        
        for (size_t j = 0; j != i; ++j) {
          if (fabs(at(i,j)) > eps || fabs(at(j,i)) > eps) {
            return false;
          };
        }
      }

      return true;
    }

double JMATH::JMatrixND::getDeterminant ( ) const

inline

Get determinant of matrix.

Returns

determinant of matrix

Definition at line 412 of file JMatrixND.hh.

    {
      JMatrixHelper& A = JMatrixHelper::getInstance();

      A.decompose(*this);
    
      double det = 1.0;
      
      for (size_t i = 0; i != A.size(); ++i) {
        det *= A[i][i];
      }
      
      return det * A.getSign();
    }

bool JMATH::JMatrixND::isPositiveDefinite ( ) const

inline

Test positive definiteness.

Returns

true if positive definite; else false

Definition at line 433 of file JMatrixND.hh.

    {
      JMatrixHelper& A = JMatrixHelper::getInstance();

      A.decompose(*this);
    
      for (size_t i = 0; i != A.size(); ++i) {
        if (A[i][i] <= 0.0) {
          return false;
        }
      }

      return true;
    }

const bool JMATH::JMatrixND::isPositiveSemiDefinite ( ) const

inline

Test positive semi-definiteness.

Returns

true if positive semi-definite; else false

Definition at line 454 of file JMatrixND.hh.

    {
      JMatrixHelper& A = JMatrixHelper::getInstance();

      A.decompose(*this);    

      for (size_t i = 0; i != A.size(); ++i) {
        if (A[i][i] < 0.0) {
          return false;
        }
      }

      return true;
    }

JMatrixND & JMATH::JMath< JMatrixND , JNullType >::mul ( const JNullType &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 273 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Function Documentation

JReader& operator>> ( JReader &  in, JMatrixND &  matrix  )

friend

Read matrix from input.

Parameters

in	reader
matrix	matrix

Returns

reader

Definition at line 477 of file JMatrixND.hh.

    {
      int size;

      in >> size;

      matrix.resize(size);

      for (row_type row = matrix.begin(); row != matrix.end(); ++row) {
        for (col_type col = row->begin(); col != row->end(); ++col) {
          in >> *col;
        }
      }

      return in;
    }

JWriter& operator<< ( JWriter &  out, const JMatrixND &  matrix  )

friend

Write matrix to output.

Parameters

out	writer
matrix	matrix

Returns

writer

Definition at line 502 of file JMatrixND.hh.

    {
      int size = matrix.size();

      out << size;

      for (const_row_type row = matrix.begin(); row != matrix.end(); ++row) {
        for (const_col_type col = row->begin(); col != row->end(); ++col) {
          out << *col;
        }
      }

      return out;
    }

std::ostream& operator<< ( std::ostream &  out, const JMatrixND &  A  )

friend

Print ASCII formatted output.

Parameters

out	output stream
A	matrix

Returns

output stream

Definition at line 525 of file JMatrixND.hh.

    {
      using namespace std;

      JFlags flags(out);

      for (const_row_type row = A.begin(); row != A.end(); ++row) {

        for (const_col_type col = row->begin(); col != row->end(); ++col) {
          out << FIXED(10,2) << *col << ' ';
        }

        out << endl;
      }

      return out;
    }

---

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

• JMatrixND.hh