crowmatrix.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2011 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef CROWMATRIX_HPP
#define CROWMATRIX_HPP 1


#include <cstdlib>
#include <iostream>
#include "matrix.hpp"
#include "error.hpp"


class CRowMatrix : public Matrix {
    int       _n;      
    int       _m;      
    int       _nz;     
    int       _asize;  
    int      *_ptr;    
    int      *_col;    
    double   *_val;    

    void reallocate( void );
    void allocate( void );

    double get_check( int i, int j ) const;
    double &set_check( int i, int j );
    double get_no_check( int i, int j ) const;
    double &set_no_check( int i, int j );

    void clear_check( int i, int j );
    void clear_no_check( int i, int j );

    void build( const class CColMatrix &mat );
    void build( const class CRowMatrix &mat );
    void build( const class CoordMatrix &mat );

public:

/* ************************************** *
 * Constructors and destructor            *
 * ************************************** */

    CRowMatrix();

    CRowMatrix( int n, int m );

    CRowMatrix( int n, int m, int nz, int asize,
                int *ptr, int *col, double *val );

    CRowMatrix( const CRowMatrix &mat );

    CRowMatrix( const class CColMatrix &mat );

    CRowMatrix( const class CoordMatrix &mat );

    CRowMatrix( const class Matrix &mat );

    ~CRowMatrix();

/* ************************************** *
 * Access and information                 *
 * ************************************** */

    int columns( void ) const { return( _m ); }

    int rows( void ) const { return( _n ); }

    void size( int &n, int &m ) const { n = _n; m = _m; }

    int nz_elements( void ) const { return( _nz ); }

    int capacity( void ) const { return( _asize ); }

/* ************************************** *
 * User level control                     *
 * ************************************** */

    void resize( int n, int m );

    void merge( CRowMatrix &mat );

    void clear( void );

    void clear( int i, int j );

    void reserve( int size );

    void order_ascending( void );

    bool check_ascending( void ) const;

    void debug_print( std::ostream &os ) const;

/* ************************************** *
 * User level matrix element access       *
 * ************************************** */

    double get( int i, int j ) const;

    double &set( int i, int j );

    void set_row( int i, int N, const int *col, const double *val );

    void construct_add( int i, int j, double val );

/* ************************************** *
 * Low level access                       *
 * ************************************** */

    int &ptr( int i ) { return( _ptr[i] ); }

    int &col( int i ) { return( _col[i] ); }

    double &val( int i ) { return( _val[i] ); }

    const int &ptr( int i ) const { return( _ptr[i] ); }

    const int &col( int i ) const { return( _col[i] ); }

    const double &val( int i ) const { return( _val[i] ); }

    void set_nz( int nz );

/* ************************************** *
 * Assignent operators                    *
 * ************************************** */

    CRowMatrix &operator=( const CRowMatrix &mat );

    CRowMatrix &operator=( const class CColMatrix &mat );

    CRowMatrix &operator=( const class CoordMatrix &mat );

    CRowMatrix &operator=( const class Matrix &mat );

/* ************************************** *
 * Matrix-Vector operations               *
 * ************************************** */

    /*  \brief Calculates \a x = \a A*b.
     */
    void multiply_by_vector( Vector &x, const Vector &b ) const;

    void lower_unit_solve( Vector &x, const Vector &b ) const;

    void upper_diag_solve( Vector &x, const Vector &b ) const;

    void LU_solve( Vector &x, const Vector &b ) const;

    friend class CColMatrix;
    friend class CoordMatrix;
    friend class Vector;
};


inline double CRowMatrix::get( int i, int j ) const
{
#ifdef SPM_RANGE_CHECK
    return( get_check( i, j ) );
#else
    return( get_no_check( i, j ) );
#endif
}    


inline double &CRowMatrix::set( int i, int j )
{
#ifdef SPM_RANGE_CHECK
    return( set_check( i, j ) );
#else
    return( set_no_check( i, j ) );
#endif
}    


inline void CRowMatrix::clear( int i, int j )
{
#ifdef SPM_RANGE_CHECK
    clear_check( i, j );
#else
    clear_no_check( i, j );
#endif
}


#endif