/home/brandes/workspace/LAMA/src/lama/storage/ELLStorage.hpp

Go to the documentation of this file.

#ifndef LAMA_ELLSTORAGE_HPP_
#define LAMA_ELLSTORAGE_HPP_

// for dll_import
#include <lama/config.hpp>

// base classes
#include <lama/storage/CRTPMatrixStorage.hpp>

namespace lama
{

template<typename T>
class LAMA_DLL_IMPORTEXPORT ELLStorage : public CRTPMatrixStorage<ELLStorage<T>, T>
{
public:

    typedef T ValueType;  

    static const char* typeName();

    ELLStorage();

    ELLStorage( const IndexType numRows, const IndexType numColumns, const ContextType con = Context::Host );

    ELLStorage( const IndexType numRows, 
                const IndexType numColumns,
                const IndexType numValuesPerRows,
                const LAMAArray<IndexType>& ia, 
                const LAMAArray<IndexType>& ja, 
                const LAMAArray<ValueType>& values  );

    ELLStorage( const ELLStorage<ValueType>& other );

    explicit ELLStorage( const _MatrixStorage& other ) {  assign( other ); }

    ELLStorage( const _MatrixStorage& other, const ContextPtr context )
            {  setContext(context); assign( other ); }

    virtual ~ELLStorage();

    ELLStorage<ValueType>& operator=( const _MatrixStorage& other)
    {  assign( other );  return *this; }

    virtual ELLStorage* copy() const;

    virtual ELLStorage* create() const;

    virtual void clear();

    void check( const char* msg ) const;

    void allocate( const IndexType numRows, const IndexType numColumns );

    virtual MatrixStorageFormat getFormat() const;

    virtual void purge();

    virtual void setIdentity( const IndexType size );

    template<typename OtherValueType>
    void buildCSR( LAMAArray<IndexType>& ia,
                   LAMAArray<IndexType>* ja,
                   LAMAArray<OtherValueType>* values,
                   const ContextPtr /* loc */ ) const;

    template<typename OtherValueType>
    void setCSRDataImpl( const IndexType numRows,
                         const IndexType numColumns,
                         const IndexType numValues,
                         const LAMAArray<IndexType>& ia,
                         const LAMAArray<IndexType>& ja,
                         const LAMAArray<OtherValueType>& values,
                         const ContextPtr loc );

    virtual void writeAt( std::ostream& stream ) const;

    const LAMAArray<IndexType>& getIA() const;

    const LAMAArray<IndexType>& getJA() const;

    const LAMAArray<ValueType>& getValues() const;

    virtual IndexType getNumValues() const;

    IndexType getNumValuesPerRow() const;

    template<typename OtherType>
    void getRowImpl( LAMAArray<OtherType>& row, const IndexType i ) const;

    template<typename OtherType>
    void getDiagonalImpl( LAMAArray<OtherType>& diagonal ) const;

    template<typename OtherType>
    void setDiagonalImpl( const LAMAArray<OtherType>& diagonal );

    void setDiagonalImpl( const Scalar scalar );

    /******************************************************************
    *  Scaling of elements in a matrix                                *
    ******************************************************************/

    template<typename OtherType>
    void scaleImpl( const LAMAArray<OtherType>& values );

    void scaleImpl( const Scalar value );

    ValueType getValue( IndexType i, IndexType j ) const;

    void prefetch( const ContextPtr location ) const;

    void wait() const;

    virtual void matrixTimesVector(
        LAMAArrayView<ValueType> result,
        const ValueType alpha, const LAMAArrayConstView<ValueType> x,
        const ValueType beta, const LAMAArrayConstView<ValueType> y ) const;

    virtual std::auto_ptr<SyncToken> matrixTimesVectorAsync(
        LAMAArrayView<ValueType> result,
        const ValueType alpha, const LAMAArrayConstView<ValueType> x,
        const ValueType beta, const LAMAArrayConstView<ValueType> y ) const;

    virtual void jacobiIterate(
        LAMAArrayView<ValueType> solution, const LAMAArrayConstView<ValueType> oldSolution,
        const LAMAArrayConstView<ValueType> rhs, const ValueType omega) const;

    virtual void jacobiIterateHalo(
        LAMAArrayView<ValueType> localSolution,
        const MatrixStorage<ValueType>& localStorage,
        const LAMAArrayConstView<ValueType> haloOldSolution,
        const ValueType omega ) const;

    virtual void matrixTimesMatrix(
        const ValueType alpha,
        const MatrixStorage<ValueType>& a,
        const MatrixStorage<ValueType>& b,
        const ValueType beta,
        const MatrixStorage<ValueType>& c );

    void compress( const ValueType eps = 0.0 );

    void swap( ELLStorage<ValueType>& other );

    virtual size_t getMemoryUsageImpl() const;

    using MatrixStorage<ValueType>::mNumRows;
    using MatrixStorage<ValueType>::mNumColumns;
    using MatrixStorage<ValueType>::mDiagonalProperty;
    using MatrixStorage<ValueType>::mRowIndexes;
    using MatrixStorage<ValueType>::mCompressThreshold;

    using MatrixStorage<ValueType>::assign;
    using MatrixStorage<ValueType>::prefetch;
    using MatrixStorage<ValueType>::getContextPtr;
    using MatrixStorage<ValueType>::setContext;

    void print() const;

private:

    IndexType mNumValuesPerRow;   

    LAMAArray<IndexType> mIa;     
    LAMAArray<IndexType> mJa;     
    LAMAArray<ValueType> mValues; 

    inline IndexType ellindex( const IndexType i, const IndexType jj ) const { return jj * mNumRows + i; }

    // Alternative addressing row-wise 
    // inline IndexType ellindex( const IndexType i, const IndexType jj ) const { return i * mNumValuesPerRow + jj; }

    virtual bool checkDiagonalProperty() const;

    void buildRowIndexes( const ContextPtr loc );

    LAMA_LOG_DECL_STATIC_LOGGER( logger );  

    void matrixTimesMatrixELL( const ValueType alpha,
                               const ELLStorage<ValueType>& a,
                               const ELLStorage<ValueType>& b );

    void matrixAddMatrixELL( const ValueType alpha,
                             const ELLStorage<ValueType>& a,
                             const ValueType beta,
                             const ELLStorage<ValueType>& b );
};

} // namespace lama

#endif // LAMA_ELLSTORAGE_HPP_