kome::core::Matrix Class Reference

matrix class More...

#include <Matrix.h>

Public Member Functions
	Matrix (const unsigned int row, const unsigned int col)
	constructor More...
	Matrix (const Matrix &mat)
	copy constructor More...
virtual	~Matrix ()
	destructor
unsigned int	getRowSize ()
	gets row size of matrix More...
unsigned int	getColSize ()
	gets col size of matrix More...
double	det ()
	calculates determinant. (This matrix must be a square matrix.) More...
double	cofactor (const unsigned int row, const unsigned int col)
	calculates cofactor (This matrix must be a square matrix.) More...
Matrix	invert ()
	gets inverse matrix (This matrix must be a square matrix.) More...
Vector	multiply (Vector &v)
	multiplies vector More...
Matrix	operator= (const Matrix &m)
	copy matrix More...
double &	operator() (const unsigned int row, const unsigned int col)
	gets reference of value of specified element More...
Matrix &	operator+= (const Matrix &m)
	matrix addition More...
Matrix &	operator-= (const Matrix &m)
	matrix subtraction More...
Matrix &	operator*= (const double k)
	scalar multiplication More...
Matrix &	operator/= (const double k)
	scalar division More...
Matrix	operator+ (const Matrix &m)
	matrix addition More...
Matrix	operator- (const Matrix &m)
	matrix subtraction More...
Matrix	operator* (const Matrix &m)
	matrix multiplication More...
Matrix	operator* (const double k)
	scalar multiplication More...
Matrix	operator/ (const double k)
	scalar division More...

Public Attributes
const unsigned int	m_row
const unsigned int	m_col
double *const	m_array

Detailed Description

matrix class

Definition at line 25 of file Matrix.h.

Constructor & Destructor Documentation

kome::core::Matrix::Matrix	(	const unsigned int	row,
		const unsigned int	col
	)

constructor

Parameters

[in]	row	length of row
[in]	col	length of col

Definition at line 29 of file Matrix.cpp.

        : m_row( row ), m_col( col ),
            m_array( ( row == 0 || col == 0 ) ? NULL : new double[ row * col ] ) {
    if( m_array != NULL ) {
        fillzero( m_array, sizeof( double ) * m_row * m_col );
    }
}

Here is the call graph for this function:

kome::core::Matrix::Matrix

(

const Matrix &

mat

)

copy constructor

Parameters

[in]

mat

Matrix object to be copied

Definition at line 38 of file Matrix.cpp.

        : m_row( mat.m_row ), m_col( mat.m_col ),
            m_array( mat.m_array == NULL ? NULL : new double[ mat.m_row * mat.m_col ] ) {
    if( m_array != NULL ) {
        memcpy( m_array, mat.m_array, sizeof( double ) * mat.m_row * mat.m_col );
    }
}

Member Function Documentation

double kome::core::Matrix::cofactor	(	const unsigned int	row,
		const unsigned int	col
	)

calculates cofactor (This matrix must be a square matrix.)

Parameters

[in]	row	row
[in]	col	col

Returns

cofactor

Definition at line 86 of file Matrix.cpp.

                                                                        {
    // check size
    if( m_row != m_col ) {
        throw FMT( "This is not a square matrix." );
    }
    if( m_row <= 1 ) {
        throw FMT( "Matrix size is illegal." );
    }

    // check parameter
    if( row >= m_row || col >= m_col ) {
        throw FMT( "The specified element does not exist. [row=%d, col=%d]", row, col );
    }

    // create matrix to calculate determinant
    Matrix m( m_row - 1 , m_col - 1 );
    for( unsigned int i = 0; i < m_row - 1; i++ ) {
        int r = ( i < row ) ? i : i + 1;
        for( unsigned int j = 0; j < m_col - 1; j++ ) {
            int c = ( j < col ) ? j : j + 1;

            m( i, j ) = operator()( r, c );
        }
    }

    // calculate cofactor
    double d = m.det();
    if( ( row + col ) % 2 != 0 ) {
        d = - d;
    }

    return d;
}

Here is the call graph for this function:

double kome::core::Matrix::det

(

)

calculates determinant. (This matrix must be a square matrix.)

Returns

determinant

Definition at line 64 of file Matrix.cpp.

                   {
    // check size
    if( m_row != m_col ) {
        throw FMT( "This is not a square matrix." );
    }
    if( m_row == 0 ) {
        throw FMT( "Matrix size is illegal." );
    }
    if( m_row == 1 ) {
        return m_array[ 0 ];
    }

    // calculate
    double d = 0.0;
    for( unsigned int i = 0; i < m_col; i++ ) {
        d += operator()( 0, i ) * cofactor( 0, i );
    }

    return d;
}

Here is the call graph for this function:

unsigned int kome::core::Matrix::getColSize

(

)

gets col size of matrix

Returns

col size of matrix

Definition at line 59 of file Matrix.cpp.

                                {
    return m_col;
}

unsigned int kome::core::Matrix::getRowSize

(

)

gets row size of matrix

Returns

row size of matrix

Definition at line 54 of file Matrix.cpp.

                                {
    return m_row;
}

Matrix kome::core::Matrix::invert

(

)

gets inverse matrix (This matrix must be a square matrix.)

Returns

inverse matrix

Definition at line 121 of file Matrix.cpp.

                      {
    // check size
    if( m_row != m_col ) {
        throw FMT( "This is not a square matrix." );
    }
    if( m_row == 0 ) {
        throw FMT( "Matrix size is illegal." );
    }

    // calculate determinant
    double d = det();
    if( d == 0.0 ) {
        throw FMT( "There isn't an inverse matrix." );
    }

    // create inverse matrix
    Matrix m( m_row, m_col );
    if( m_row == 1 ) {
        m( 0, 0 ) = 1.0 / d;
    }
    else {
        for( unsigned int i = 0; i < m_row; i++ ) {
            for( unsigned int j = 0; j < m_col; j++ ) {
                m( i, j ) = cofactor( j, i ) / d;
            }
        }
    }

    return m;
}

Here is the call graph for this function:

Vector kome::core::Matrix::multiply

(

Vector &

v

)

multiplies vector

Returns

multiplied vector

Definition at line 153 of file Matrix.cpp.

                                   {
    // check size
    if( m_col != v.getDimention() ) {
        throw FMT( "The size is illegal. [col=%d, dim=%d]", m_row, v.getDimention() );
    }

    // multiply
    Vector tmp( m_row );
    for( unsigned int i = 0; i < m_row; i++ ) {
        double elm = 0.0;
        for( unsigned int j = 0; j < m_col; j++ ) {
            elm += (*this)( i, j ) * v( j );
        }

        tmp( i ) = elm;
    }

    return tmp;
}

Here is the call graph for this function:

double & kome::core::Matrix::operator()	(	const unsigned int	row,
		const unsigned int	col
	)

gets reference of value of specified element

Parameters

[in]	row	row
[in]	col	col

Returns

reference of value of specified element

Definition at line 187 of file Matrix.cpp.

                                                                           {
    // check parameter
    if( row >= m_row || col >= m_col ) {
        throw FMT( "The specified element does not exist. [row=%d, col=%d]", row, col );
    }

    return m_array[ row + col * m_row ];
}

Matrix kome::core::Matrix::operator*

(

const Matrix &

m

)

matrix multiplication

Parameters

[in]

m

matrix to multiple

Returns

multiplication matrix

Definition at line 275 of file Matrix.cpp.

                                          {
    // check size
    if( this->m_col != m.m_row ) {
        throw FMT( "Matrix size is illegal." );
    }

    // copy
    Matrix tmp( this->m_row, m.m_col );

    // change size
    unsigned int num = this->m_col;

    // multiplication
    for( unsigned int i = 0; i < this->m_row; i++ ) {
        for( unsigned int j = 0; j < m.m_col; j++ ) {
            double val = 0.0;
            for( unsigned int k = 0; k < num; k++ ) {
                val += this->m_array[ i + k * this->m_row ] * m.m_array[ k + j * m.m_row ];
            }
            tmp( i, j ) = val;
        }
    }

    return tmp;
}

Matrix kome::core::Matrix::operator*

(

const double

k

)

scalar multiplication

Parameters

[in]

k

real number to multiple

Returns

multiplication matrix

Definition at line 302 of file Matrix.cpp.

                                         {
    Matrix tmp = *this;
    tmp *= k;

    return tmp;
}

Matrix & kome::core::Matrix::operator*=

(

const double

k

)

scalar multiplication

Parameters

[in]

k

real number to multiple

Returns

multiplication matrix

Definition at line 233 of file Matrix.cpp.

                                           {
    // get the size of array
    unsigned int size = m_row * m_col;

    // multiplication
    for( unsigned int i = 0; i < size; i++ ) {
        m_array[ i ] *= k;
    }

    return *this;
}

Matrix kome::core::Matrix::operator+

(

const Matrix &

m

)

matrix addition

Parameters

[in]

m

matrix to add

Returns

addition matrix

Definition at line 259 of file Matrix.cpp.

                                          {
    Matrix tmp = *this;
    tmp += m;

    return tmp;
}

Matrix & kome::core::Matrix::operator+=

(

const Matrix &

m

)

matrix addition

Parameters

[in]

m

matrix to add

Returns

addition matrix

Definition at line 197 of file Matrix.cpp.

                                            {
    // check size
    if( m.m_row != m_row || m.m_col != m_col ) {
        throw FMT( "Matrix size is illegal." );
    }

    // size
    unsigned int size = m_row * m_col;

    // addition
    for( unsigned int i = 0; i < size; i++ ) {
        m_array[ i ] += m.m_array[ i ];
    }

    return *this;
}

Matrix kome::core::Matrix::operator-

(

const Matrix &

m

)

matrix subtraction

Parameters

[in]

m

matrix to subtract

Returns

subtraction matrix

Definition at line 267 of file Matrix.cpp.

                                          {
    Matrix tmp = *this;
    tmp -= m;

    return tmp;
}

Matrix & kome::core::Matrix::operator-=

(

const Matrix &

m

)

matrix subtraction

Parameters

[in]

m

matrix to subtract

Returns

subtraction matrix

Definition at line 215 of file Matrix.cpp.

                                            {
    // check size
    if( m.m_row != m_row || m.m_col != m_col ) {
        throw FMT( "Matrix size is illegal." );
    }

    // size
    unsigned int size = m_row * m_col;

    // addition
    for( unsigned int i = 0; i < size; i++ ) {
        m_array[ i ] -= m.m_array[ i ];
    }

    return *this;
}

Matrix kome::core::Matrix::operator/

(

const double

k

)

scalar division

Parameters

[in]

k

real number to divide

Returns

division matrix

Definition at line 310 of file Matrix.cpp.

                                         {
    Matrix tmp = *this;
    tmp /= k;

    return tmp;
}

Matrix & kome::core::Matrix::operator/=

(

const double

k

)

scalar division

Parameters

[in]

k

real number to divide

Returns

division matrix

Definition at line 246 of file Matrix.cpp.

                                           {
    // get the size of array
    unsigned int size = m_row * m_col;

    // dividion
    for( unsigned int i = 0; i < size; i++ ) {
        m_array[ i ] /= k;
    }

    return *this;
}

Matrix kome::core::Matrix::operator=

(

const Matrix &

m

)

copy matrix

Parameters

[in]

m

source matrix to be copied

Returns

copied matrix

Definition at line 174 of file Matrix.cpp.

                                          {
    if( m.m_row != m_row || m.m_col != m_col ) {
        throw FMT( "Matrix size is illegal." );
    }

    if( m_array != NULL ) {
        memcpy( m_array, m.m_array, sizeof( double ) * m_row * m_col );
    }

    return *this;
}

Member Data Documentation

double* const kome::core::Matrix::m_array

value array

Definition at line 54 of file Matrix.h.

const unsigned int kome::core::Matrix::m_col

length of col

Definition at line 52 of file Matrix.h.

const unsigned int kome::core::Matrix::m_row

length of row

Definition at line 50 of file Matrix.h.

---

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

• CoreToolkits/Matrix.h
• CoreToolkits/Matrix.cpp