JMATH::JMatrixND_t Struct Reference

Basic NxN matrix. More...

#include <JMatrixND.hh>

Inheritance diagram for JMATH::JMatrixND_t:

Public Member Functions
	JMatrixND_t ()
	Default constructor. More...
	JMatrixND_t (const JMatrixND_t &A)
	Copy constructor. More...
	JMatrixND_t (JMatrixND_t &&A)
	Move constructor. More...
	~JMatrixND_t ()
	Destructor. More...
void	clear ()
	Clear memory. More...
void	resize (const size_t size)
	Resize matrix. More...
JMatrixND_t &	reset ()
	Set matrix to the null matrix. More...
void	set (const JMatrixND_t &A)
	Set matrix. More...
void	swap (JMatrixND_t &A)
	Swap matrices. More...
JMatrixND_t &	transpose ()
	Transpose. More...
size_t	size () const
	Get dimension of matrix. More...
size_t	capacity () const
	Get capacity of dimension. More...
bool	empty () const
	Check emptyness. More...
const double *	data () const
	Get pointer to data. More...
double *	data ()
	Get pointer to data. More...
const double *	operator[] (size_t row) const
	Get row data. More...
double *	operator[] (size_t row)
	Get row data. More...
double	operator() (const size_t row, const size_t col) const
	Get matrix element. More...
double &	operator() (const size_t row, const size_t col)
	Get matrix element. 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...

Protected Attributes
double *	__p
	pointer to data More...
size_t	__n
	dimension of matrix More...
size_t	__m
	capacity of matrix More...

Detailed Description

Basic NxN matrix.

Definition at line 36 of file JMatrixND.hh.

Constructor & Destructor Documentation

JMATH::JMatrixND_t::JMatrixND_t ( )

inline

Default constructor.

Definition at line 40 of file JMatrixND.hh.

                  :
      __p(NULL),
      __n(0),
      __m(0)
    {}

JMATH::JMatrixND_t::JMatrixND_t ( const JMatrixND_t &  A )

inline

Copy constructor.

Parameters

A

matrix

Definition at line 52 of file JMatrixND.hh.

                                      :
      JMatrixND_t()
    {
      set(A);
    }

JMATH::JMatrixND_t::JMatrixND_t ( JMatrixND_t &&  A )

inline

Move constructor.

Parameters

A

matrix

Definition at line 64 of file JMatrixND.hh.

                                 :
      JMatrixND_t()
    {
      swap(A);
    }

JMATH::JMatrixND_t::~JMatrixND_t ( )

inline

Destructor.

Definition at line 74 of file JMatrixND.hh.

    {
      clear();
    }

Member Function Documentation

void JMATH::JMatrixND_t::clear ( )

inline

Clear memory.

Definition at line 83 of file JMatrixND.hh.

    {
      if (__p != NULL) {
        delete [] __p;
      }

      __p = NULL;
      __n = 0;
      __m = 0;
    }

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

inline

Resize matrix.

Note that this method does not maintain data in the matrix.

Parameters

size

dimension

Definition at line 102 of file JMatrixND.hh.

    {
      if (size != this->__n) {

        if (size > this->__m) {

          if (__p != NULL) {
            delete[] __p;
          }

          __m = size;
          __p = new double[__m*__m];

          if (__p == NULL) {
            THROW(JNewException, "JMatrixND::resize(" << size << "): Memory allocation failure.");
          }
        }

        __n = size;
      }
    }

JMatrixND_t& JMATH::JMatrixND_t::reset ( )

inline

Set matrix to the null matrix.

Returns

this matrix

Definition at line 130 of file JMatrixND.hh.

    {
      double* p0 = this->data();
      double* p1 = this->data();

      if (!this->empty()) {

        for (size_t i = this->size(); i != 0; --i, ++p1) {
          *p1 = 0.0;
        }

        for (size_t i = this->size(); i != 1; --i, p1 += this->size()) {
          memcpy(p1, p0, this->size() * sizeof(double));
        }
      }

      return *this;
    }

void JMATH::JMatrixND_t::set ( const JMatrixND_t &  A )

inline

Set matrix.

Parameters

A

matrix

Definition at line 155 of file JMatrixND.hh.

    {
      this->resize(A.size());

      memcpy(this->data(), A.data(), A.size() * A.size() * sizeof(double));
    }

void JMATH::JMatrixND_t::swap ( JMatrixND_t &  A )

inline

Swap matrices.

Parameters

A

matrix

Definition at line 168 of file JMatrixND.hh.

    {
      using std::swap;

      swap(this->__p, A.__p);
      swap(this->__n, A.__n);
      swap(this->__m, A.__m);
    }

JMatrixND_t& JMATH::JMatrixND_t::transpose ( )

inline

Transpose.

Returns

this matrix

Definition at line 183 of file JMatrixND.hh.

    {
      using std::swap;

      for (size_t row = 0; row != this->size(); ++row) {
        for (size_t col = 0; col != row; ++col) {
          swap((*this)(row,col), (*this)(col,row));
        }
      }

      return *this;
    }

size_t JMATH::JMatrixND_t::size ( ) const

inline

Get dimension of matrix.

Returns

dimension

Definition at line 202 of file JMatrixND.hh.

    {
      return __n;
    }

size_t JMATH::JMatrixND_t::capacity ( ) const

inline

Get capacity of dimension.

Returns

capacity

Definition at line 213 of file JMatrixND.hh.

    {
      return __m;
    }

bool JMATH::JMatrixND_t::empty ( ) const

inline

Check emptyness.

Returns

true if empty; else false

Definition at line 224 of file JMatrixND.hh.

    {
      return __n == 0;
    }

const double* JMATH::JMatrixND_t::data ( ) const

inline

Get pointer to data.

Returns

pointer to data.

Definition at line 235 of file JMatrixND.hh.

    {
      return __p;
    }

double* JMATH::JMatrixND_t::data ( )

inline

Get pointer to data.

Returns

pointer to data.

Definition at line 246 of file JMatrixND.hh.

    {
      return __p;
    }

const double* JMATH::JMatrixND_t::operator[] ( size_t  row ) const

inline

Get row data.

Parameters

row	row number

Returns

pointer to row data

Definition at line 258 of file JMatrixND.hh.

    {
      return __p + row*__n;
    }

double* JMATH::JMatrixND_t::operator[] ( size_t  row )

inline

Get row data.

Parameters

row	row number

Returns

pointer to row data

Definition at line 270 of file JMatrixND.hh.

    {
      return __p + row*__n;
    }

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

inline

Get matrix element.

Parameters

row	row number
col	column number

Returns

matrix element at (row,col)

Definition at line 283 of file JMatrixND.hh.

    {
      return *(__p + row*__n + col);
    }

double& JMATH::JMatrixND_t::operator() ( const size_t  row, const size_t  col  )

inline

Get matrix element.

Parameters

row	row number
col	column number

Returns

matrix element at (row,col)

Definition at line 296 of file JMatrixND.hh.

    {
      return *(__p + row*__n + col);
    }

double JMATH::JMatrixND_t::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 309 of file JMatrixND.hh.

    {
      if (row >= this->size() ||
          col >= this->size()) {
        THROW(JIndexOutOfRange, "JMatrixND::at(" << row << "," << col << "): index out of range.");
      }

      return (*this)(row, col);
    }

double& JMATH::JMatrixND_t::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 327 of file JMatrixND.hh.

    {
      if (row >= this->size() ||
          col >= this->size()) {
        THROW(JIndexOutOfRange, "JMatrixND::at(" << row << "," << col << "): index out of range.");
      }

      return (*this)(row, col);
    }

Member Data Documentation

double* JMATH::JMatrixND_t::__p

protected

pointer to data

Definition at line 339 of file JMatrixND.hh.

size_t JMATH::JMatrixND_t::__n

protected

dimension of matrix

Definition at line 340 of file JMatrixND.hh.

size_t JMATH::JMatrixND_t::__m

protected

capacity of matrix

Definition at line 341 of file JMatrixND.hh.

---

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

• JMatrixND.hh