coordmatrix.hpp

Go to the documentation of this file.

 
/* Copyright (c) 2005-2009,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 COORDMATRIX_HPP
#define COORDMATRIX_HPP 1
 
 
#include <cstdlib>
#include <iostream>
#include "matrix.hpp"
#include "error.hpp"
 
 
class CoordMatrix : public Matrix {
    int       _n;      
    int       _m;      
    int       _nz;     
    int       _asize;  
    int      *_row;    
    int      *_col;    
    double   *_val;    
 
    void allocate( void );
    void reallocate( 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            *
 * ************************************** */
 
    CoordMatrix() : _n(0), _m(0), _nz(0), _asize(0), _row(NULL), _col(NULL), _val(NULL) { }
 
    CoordMatrix( int n, int m );
 
    CoordMatrix( int n, int m, int nz, 
                 const int *row, const int *col, const int *val );
 
    CoordMatrix( const CoordMatrix &mat );
 
    CoordMatrix( const class CRowMatrix &mat );
 
    CoordMatrix( const class CColMatrix &mat );
 
    CoordMatrix( const class Matrix &mat );
 
    ~CoordMatrix();
 
/* ************************************** *
 * 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( CoordMatrix &mat );
 
    void clear( void );
 
    void clear( int i, int j );
 
    void reserve( int size );
 
    void order_ascending_row_column( void );
 
    void order_ascending_column_row( void );
 
    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_no_duplicate_check( int i, int j, double vval );
 
/* ************************************** *
 * Low level access                       *
 * ************************************** */
 
    int &row( int i ) { return( _row[i] ); }
 
    int &col( int i ) { return( _col[i] ); }
 
    double &val( int i ) { return( _val[i] ); }
 
    const int &row( int i ) const { return( _row[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                    *
 * ************************************** */
 
    CoordMatrix &operator=( const CoordMatrix &mat );
    CoordMatrix &operator=( const CColMatrix &mat );
    CoordMatrix &operator=( const CRowMatrix &mat );
    CoordMatrix &operator=( const Matrix &mat );
 
/* ************************************** *
 * Matrix-Vector operations               *
 * ************************************** */
 
    /*  \brief Calculates \a x = \a A*b.
     */
    void multiply_by_vector( Vector &res, const Vector &rhs ) const;
    void lower_unit_solve( Vector &y, const Vector &b ) const;
    void upper_diag_solve( Vector &x, const Vector &y ) const;
 
 
    friend class CRowMatrix;
    friend class CColMatrix;
};
 
 
inline double CoordMatrix::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 &CoordMatrix::set( int i, int j )
{
#ifdef SPM_RANGE_CHECK
    return( set_check( i, j ) );
#else
    return( set_no_check( i, j ) );
#endif
}    
 
 
inline void CoordMatrix::clear( int i, int j )
{
#ifdef SPM_RANGE_CHECK
    clear_check( i, j );
#else
    clear_no_check( i, j );
#endif
}
 
 
#endif