mvector.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-2010 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 MVECTOR_HPP
#define MVECTOR_HPP 1


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


class Vector {
    int       _n;    
    double   *_val;  

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

public:

    struct VectorRef {
        const Vector *_vec;  
        double        _coef; 

        VectorRef() : _vec(NULL), _coef(1.0) {}

        VectorRef( const Vector *vec, double coef ) : _vec(vec), _coef(coef) {}
    };

    struct VectorLA {
        std::vector<VectorRef> _refs; 

        VectorLA() {}

        VectorLA( const VectorLA &vecla ) : _refs(vecla._refs) {}

        VectorLA( const Vector &vec ) {
            VectorRef ref( &vec, 1.0 );
            _refs.push_back( ref );
        }

        VectorLA( const Vector &vec, double coef ) {
            VectorRef ref( &vec, coef );
            _refs.push_back( ref );
        }

        double operator[]( int i ) const;

        double operator()( int i ) const;

        VectorLA operator+( const VectorLA &vecla ) const;

        VectorLA operator-( const VectorLA &vecla ) const;

        VectorLA operator-() const;

        VectorLA operator*( double x ) const;

        friend VectorLA operator*( double x, const VectorLA &vecla );
    };

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

    Vector() : _n(0), _val(NULL) {}

    Vector( int n );

    Vector( int n, const double *val );

    Vector( int n, double val );

    Vector( const Vector &vec );

    Vector( const VectorLA &vecla );

    Vector( const struct MatrixMulVec &matvec );

    ~Vector();

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

    void resize( int n );

    void clear( void );

    void merge( Vector &vec );

    double *get_data( void ) { return( _val ); }

    const double *get_data( void ) const { return( _val ); }

    VectorLA operator+( const VectorLA &vecla ) const;

    VectorLA operator-( const VectorLA &vecla ) const;

    VectorLA operator-() const;

    VectorLA operator*( double x ) const;

    Vector &operator+=( const VectorLA &vecla );

    Vector &operator-=( const VectorLA &vecla );

    Vector &operator*=( double x );

    Vector &operator=( double x );

    Vector &operator=( const Vector &vec );

    Vector &operator=( const VectorLA &vecla );

    Vector &operator=( const struct MatrixMulVec &matvec );

    bool operator==( const Vector &vec ) const;

    bool operator!=( const Vector &vec ) const;

    double &operator[]( int i );

    double &operator()( int i );

    double operator[]( int i ) const;

    double operator()( int i ) const;

    friend class HBIO;
    friend class Matrix;
    friend class CRowMatrix;
    friend class CColMatrix;
    friend class CoordMatrix;

    friend VectorLA operator*( double x, Vector &vec );

    friend std::ostream &operator<<( std::ostream &os, const Vector &vec );

    friend double dot_prod( const Vector &vec1, const Vector &vec2 );

    friend double norm1( const Vector &vec );

    friend double norm2( const Vector &vec );

    friend double ssqr( const Vector &vec );

    friend double min( const Vector &vec );

    friend double min_abs( const Vector &vec );

    friend double max( const Vector &vec );

    friend double max_abs( const Vector &vec );

    friend void swap( Vector &vec1, Vector &vec2 );
};


inline double Vector::VectorLA::operator[]( int i ) const {
#ifdef SPM_RANGE_CHECK
    if( i >= _refs[0]._vec->_n )
        throw( ErrorRange( ERROR_LOCATION, i, _refs[0]._vec->_n ) );
#endif
    double res = 0.0;
    std::vector<VectorRef>::const_iterator itend = _refs.end();
    for( std::vector<VectorRef>::const_iterator it = _refs.begin(); it != itend; it++ )
        res += (it->_coef) * (*(it->_vec))[i];
    return( res );
}


inline double Vector::VectorLA::operator()( int i ) const {
#ifdef SPM_RANGE_CHECK
    if( i >= _refs[0]._vec->_n )
        throw( ErrorRange( ERROR_LOCATION, i, _refs[0]._vec->_n ) );
#endif
    double res = 0.0;
    std::vector<VectorRef>::const_iterator itend = _refs.end();
    for( std::vector<VectorRef>::const_iterator it = _refs.begin(); it != itend; it++ )
        res += (it->_coef) * (*(it->_vec))[i];
    return( res );
}


inline double &Vector::operator[]( int i ) {
#ifdef SPM_RANGE_CHECK
    if( i >= _n )
        throw( ErrorRange( ERROR_LOCATION, i, _n ) );
#endif
    return( _val[i] );
}


inline double &Vector::operator()( int i ) {
#ifdef SPM_RANGE_CHECK
    if( i >= _n )
        throw( ErrorRange( ERROR_LOCATION, i, _n ) );
#endif
    return( _val[i] );
}


inline double Vector::operator[]( int i ) const {
#ifdef SPM_RANGE_CHECK
    if( i >= _n )
        throw( ErrorRange( ERROR_LOCATION, i, _n ) );
#endif
    return( _val[i] );
}


inline double Vector::operator()( int i ) const {
#ifdef SPM_RANGE_CHECK
    if( i >= _n )
        throw( ErrorRange( ERROR_LOCATION, i, _n ) );
#endif
    return( _val[i] );
}





#endif