#include <GIDI_data.hpp>

Public Member Functions
	Matrix (std::size_t a_rows, std::size_t a_columns)
	Matrix (Matrix const &a_gidi_matrix)
	~Matrix ()
Matrix &	operator= (Matrix const &a_rhs)
std::size_t	size () const
Vector &	operator[] (std::size_t a_index)
Vector const &	operator[] (std::size_t a_index) const
void	operator() (std::size_t a_row, std::size_t a_column, double a_value)
std::vector< Vector > const &	matrix () const
Matrix	operator+ (double a_value) const
Matrix &	operator+= (double a_value)
Matrix	operator+ (Matrix const &a_rhs) const
Matrix &	operator+= (Matrix const &a_rhs)
Matrix	operator- (double a_value) const
Matrix &	operator-= (double a_value)
Matrix	operator- (Matrix const &a_rhs) const
Matrix &	operator-= (Matrix const &a_rhs)
Matrix	operator* (double a_value) const
Matrix &	operator*= (double a_value)
Matrix	operator/ (double a_value) const
Matrix &	operator/= (double a_value)
std::size_t	numberOfColumns () const
void	set (std::size_t a_row, std::size_t a_column, double a_value)
void	set (std::size_t a_row, Vector const &a_vector)
void	push_back (Vector const &a_vector)
Matrix	transpose ()
void	reverse ()
void	print (std::string const &a_prefixForRow) const

Detailed Description

This class stores a mathematical matrix and has methods that perform several matrix operations (e.g., addition, subtraction).

Definition at line 116 of file GIDI_data.hpp.

Constructor & Destructor Documentation

◆ Matrix() [1/2]

GIDI::Matrix::Matrix	(	std::size_t	a_rows,
		std::size_t	a_columns )

Parameters

a_rows	[in] Number of rows of the matrix.
a_columns	[in] Number of columns of the matrix.

Definition at line 24 of file GIDI_matrix.cc.

                                                      {
 
    m_matrix.resize( a_rows );
 
    for( std::size_t i1 = 0; i1 < a_rows; ++i1 ) m_matrix[i1].resize( a_columns );
}

Referenced by Matrix(), operator*(), operator*=(), operator+(), operator+(), operator+=(), operator+=(), operator-(), operator-(), operator-=(), operator-=(), operator/(), operator/=(), operator=(), and transpose().

◆ Matrix() [2/2]

GIDI::Matrix::Matrix ( Matrix const & a_matrix )

Parameters

a_matrix [in] Matrix to copy.

Definition at line 36 of file GIDI_matrix.cc.

                                       {
 
    std::size_t rows = a_matrix.size( );
 
    m_matrix.resize( rows );
 
    for( std::size_t i1 = 0; i1 < rows; ++i1 ) m_matrix[i1] = a_matrix[i1];
}

◆ ~Matrix()

GIDI::Matrix::~Matrix ( )

Definition at line 48 of file GIDI_matrix.cc.

                 {
 
}

Member Function Documentation

◆ matrix()

std::vector< Vector > const & GIDI::Matrix::matrix ( ) const

inline

Definition at line 138 of file GIDI_data.hpp.

138{ return( m_matrix ); }

Referenced by operator=().

◆ numberOfColumns()

std::size_t GIDI::Matrix::numberOfColumns ( ) const

Returns the number of columns of this.

Returns: The number of columns of this.

Definition at line 274 of file GIDI_matrix.cc.

                                         {
 
    if( size( ) == 0 ) return( 0 );
    return( m_matrix[0].size( ) );
}

Referenced by operator+=(), operator-=(), and transpose().

◆ operator()()

void GIDI::Matrix::operator()	(	std::size_t	a_row,
		std::size_t	a_column,
		double	a_value )

inline

Sets the cell at row a_row and column a_column to a_value.

Parameters

a_row	The cell's row.
a_column	The cell's row.
a_value	The value to put in the cell.

Definition at line 133 of file GIDI_data.hpp.

136 { m_matrix[a_row][a_column] = a_value; }

◆ operator*()

Matrix GIDI::Matrix::operator* ( double a_value ) const

Returns a new Matrix whose cells are this multiplied by a_value.

Parameters

a_value [in] The value to multiply each cell by.

Returns: New Matrix whose cells are this multiply by a_value.

Definition at line 216 of file GIDI_matrix.cc.

                                               {
 
    Matrix gidiMatrix( *this );
 
    gidiMatrix *= a_value;
    return( gidiMatrix );
}

◆ operator*=()

Matrix & GIDI::Matrix::operator*= ( double a_value )

Multiplies each cell of this by a_value.

Parameters

a_value [in] The value to multiply each cell by.

Returns: Returns reference to this.

Definition at line 231 of file GIDI_matrix.cc.

                                         {
 
    for( std::vector<Vector>::iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter ) *iter *= a_value;
 
    return( *this );
}

◆ operator+() [1/2]

Matrix GIDI::Matrix::operator+ ( double a_value ) const

Returns a new Matrix whose cells are this plus a_value.

Parameters

a_value [in] The value to add to each cell.

Returns: New Matrix whose cells are this plus a_value.

Definition at line 76 of file GIDI_matrix.cc.

                                               {
 
    Matrix gidiMatrix( *this );
 
    gidiMatrix += a_value;
    return( gidiMatrix );
}

◆ operator+() [2/2]

Matrix GIDI::Matrix::operator+ ( Matrix const & a_rhs ) const

Adds two Matrices.

Parameters

a_rhs [in] Matrix to add to this.

Returns: New Matrix that is the matrix sum of this and a_rhs.

Definition at line 105 of file GIDI_matrix.cc.

                                                    {
 
    Matrix gidiMatrix( *this );
 
    gidiMatrix += a_rhs;
    return( gidiMatrix );
}

◆ operator+=() [1/2]

Matrix & GIDI::Matrix::operator+= ( double a_value )

Adds a_value to each cell of this.

Parameters

a_value [in] The value to add to each cell.

Returns: Returns reference to this.

Definition at line 91 of file GIDI_matrix.cc.

                                         {
 
    for( std::vector<Vector>::iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter ) *iter += a_value;
 
    return( *this );
}

◆ operator+=() [2/2]

Matrix & GIDI::Matrix::operator+= ( Matrix const & a_rhs )

Adds a_rhs to this.

Parameters

a_rhs [in] Matrix to add to this.

Returns: Returns reference to this.

Definition at line 120 of file GIDI_matrix.cc.

                                              {
 
    std::size_t i1, rhs_size = a_rhs.size( );
 
    if( rhs_size == 0 ) return( *this );                           // Do nothing if rhs is empty.
 
    if( size( ) == 0 ) {
        for( i1 = 0; i1 < rhs_size; ++i1 ) m_matrix.push_back( Vector( a_rhs.numberOfColumns( ) ) );
    }
 
    if( size( ) != a_rhs.size( ) ) throw Exception( "matrix sizes differ." );
    if( m_matrix[0].size( ) != a_rhs[0].size( ) ) throw Exception( "matrix colums numbers differ." );
 
    i1 = 0;
    for( std::vector<Vector>::iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter, ++i1 ) *iter += a_rhs[i1];
 
    return( *this );
}

◆ operator-() [1/2]

Matrix GIDI::Matrix::operator- ( double a_value ) const

Returns a new Matrix whose cells are this minus a_value.

Parameters

a_value [in] The value to subtract from each cell.

Returns: New Matrix whose cells are this plus a_value.

Definition at line 146 of file GIDI_matrix.cc.

                                               {
 
    Matrix gidiMatrix( *this );
 
    gidiMatrix -= a_value;
    return( gidiMatrix );
}

◆ operator-() [2/2]

Matrix GIDI::Matrix::operator- ( Matrix const & a_rhs ) const

Subtracts a_rhs from this.

Parameters

a_rhs [in] Matrix to subtract from this.

Returns: New Matrix that is this minus a_rhs.

Definition at line 175 of file GIDI_matrix.cc.

                                                    {
 
    Matrix gidiMatrix( *this );
 
    gidiMatrix -= a_rhs;
    return( gidiMatrix );
}

◆ operator-=() [1/2]

Matrix & GIDI::Matrix::operator-= ( double a_value )

Subtracts a_value from each cell of this.

Parameters

a_value [in] The value to subtract from each cell.

Returns: Returns reference to this.

Definition at line 161 of file GIDI_matrix.cc.

                                         {
 
    for( std::vector<Vector>::iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter ) *iter -= a_value;
 
    return( *this );
}

◆ operator-=() [2/2]

Matrix & GIDI::Matrix::operator-= ( Matrix const & a_rhs )

Subtracts a_rhs to this.

Parameters

a_rhs [in] Matrix to subtract from this.

Returns: Returns reference to this.

Definition at line 190 of file GIDI_matrix.cc.

                                              {
 
    std::size_t i1, rhs_size = a_rhs.size( );
 
    if( rhs_size == 0 ) return( *this );                           // Do nothing if rhs is empty.
 
    if( size( ) == 0 ) {
        for( i1 = 0; i1 < rhs_size; ++i1 ) m_matrix.push_back( Vector( a_rhs.numberOfColumns( ) ) );
    }
 
    if( size( ) != a_rhs.size( ) ) throw Exception( "matrix sizes differ." );
    if( m_matrix[0].size( ) != a_rhs[0].size( ) ) throw Exception( "matrix colums numbers differ." );
 
    i1 = 0;
    for( std::vector<Vector>::iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter, ++i1 ) *iter -= a_rhs[i1];
 
    return( *this );
}

◆ operator/()

Matrix GIDI::Matrix::operator/ ( double a_value ) const

Returns a new Matrix whose cells are this divided by a_value.

Parameters

a_value [in] The value to divide each cell by.

Returns: New Matrix whose cells are this divided by a_value.

Definition at line 245 of file GIDI_matrix.cc.

                                               {
 
    Matrix gidiMatrix( *this );
 
    gidiMatrix /= a_value;
    return( gidiMatrix );
}

◆ operator/=()

Matrix & GIDI::Matrix::operator/= ( double a_value )

Divides each cell of this by a_value.

Parameters

a_value [in] The value to divide each cell by.

Returns: Returns reference to this.

Definition at line 260 of file GIDI_matrix.cc.

                                         {
 
    if( a_value == 0 ) throw Exception( "divide by zero." );
    for( std::vector<Vector>::iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter ) *iter /= a_value;
 
    return( *this );
}

◆ operator=()

Matrix & GIDI::Matrix::operator= ( Matrix const & a_rhs )

The assignment operator. This method sets the members of this to those of a_rhs.

Parameters

a_rhs [in] Instance whose member are used to set the members of this.

Returns: A reference to the updated Matrix instance.

Definition at line 60 of file GIDI_matrix.cc.

                                             {
 
    if( this != &a_rhs ) {
        m_matrix = a_rhs.matrix( );
    }
 
    return( *this );
}

◆ operator[]() [1/2]

Vector & GIDI::Matrix::operator[] ( std::size_t a_index )

inline

Returns a reference to the (a_index-1)th row.

Definition at line 129 of file GIDI_data.hpp.

◆ operator[]() [2/2]

Vector const & GIDI::Matrix::operator[] ( std::size_t a_index ) const

inline

Returns a reference to the (a_index-1)th row.

Definition at line 130 of file GIDI_data.hpp.

◆ print()

void GIDI::Matrix::print ( std::string const & a_prefixForRow ) const

Prints the contents of this by calling the print method of each row with a_prefixForRow as an argument.

Parameters

a_prefixForRow [in] Argument passed to each row's print method.

Definition at line 333 of file GIDI_matrix.cc.

                                                          {
 
    for( std::vector<Vector>::const_iterator iter = m_matrix.begin( ); iter < m_matrix.end( ); ++iter ) iter->print( a_prefixForRow );
}

◆ push_back()

void GIDI::Matrix::push_back ( Vector const & a_vector )

Adds a row to this.

Parameters

a_vector [in] The Vector to add to this as another row.

Definition at line 286 of file GIDI_matrix.cc.

                                               {
 
    if( size( ) > 0 ) {
        if( (*this)[0].size( ) != a_vector.size( ) ) throw Exception( "matrix::push_back: size different" );
    }
    m_matrix.push_back( a_vector );
}

Referenced by GIDI::collapse().

◆ reverse()

void GIDI::Matrix::reverse ( )

Reverse the rows of this.

Definition at line 313 of file GIDI_matrix.cc.

                      {
 
    std::size_t i2 = size( ), n_2 = i2 / 2;
 
    for( std::size_t i1 = 0; i1 < i2; ++i1 ) m_matrix[i1].reverse( );
    --i2;
    for( std::size_t i1 = 0; i1 < n_2; ++i1, --i2 ) {
        Vector temp = m_matrix[i1];
 
        m_matrix[i1] = m_matrix[i2];
        m_matrix[i2] = temp;
    }
}

Referenced by reverse().

◆ set() [1/2]

void GIDI::Matrix::set	(	std::size_t	a_row,
		std::size_t	a_column,
		double	a_value )

inline

Sets the cell at row a_row and column a_column to a_value.

Parameters

a_row	The cell's row.
a_column	The cell's row.
a_value	The value to put in the cell.

Definition at line 158 of file GIDI_data.hpp.

161 { m_matrix[a_row][a_column] = a_value; }

Referenced by GIDI::Reaction::multiGroupProductMatrix().

◆ set() [2/2]

void GIDI::Matrix::set	(	std::size_t	a_row,
		Vector const &	a_vector )

inline

Sets the row at a_row to a_vector.

Parameters

a_row	The row to set.
a_vector	The Vector to set at row a_row.

Definition at line 163 of file GIDI_data.hpp.

165 { m_matrix[a_row] = a_vector; }

◆ size()

std::size_t GIDI::Matrix::size ( ) const

inline

Returns the number of rows or this.

Definition at line 127 of file GIDI_data.hpp.

Referenced by GIDI::collapse(), GIDI::ProtareTNSL::combineMatrices(), Matrix(), GIDI::ProtareSingle::multiGroupTransportCorrection(), GIDI::ProtareTNSL::multiGroupTransportCorrection(), numberOfColumns(), operator+=(), operator-=(), push_back(), reverse(), GIDI::transportCorrect(), and transpose().

◆ transpose()

Matrix GIDI::Matrix::transpose ( )

Transposes the cells of this.

Definition at line 298 of file GIDI_matrix.cc.

                          {
 
    std::size_t __numberOfColumns( numberOfColumns( ) );
    Matrix __matrix( __numberOfColumns, size( ) );
 
    for( std::size_t i1 = 0; i1 < size( ); ++i1 ) {
        for( std::size_t i2 = 0; i2 < __numberOfColumns; ++i2 ) __matrix( i2, i1, (*this)[i1][i2] );
    }
    return( __matrix );
}

Referenced by GIDI::collapse().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Matrix() [1/2]

◆ Matrix() [2/2]

◆ ~Matrix()

Member Function Documentation

◆ matrix()

◆ numberOfColumns()

◆ operator()()

◆ operator*()

◆ operator*=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/()

◆ operator/=()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ push_back()

◆ reverse()

◆ set() [1/2]

◆ set() [2/2]

◆ size()

◆ transpose()