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

Go to the documentation of this file.

#ifndef LAMA_JDSSTORAGE_HPP_
#define LAMA_JDSSTORAGE_HPP_

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

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

// others
#include <lama/LAMAArray.hpp>
#include <lama/Scalar.hpp>

#include <lama/distribution/Distribution.hpp>

namespace lama
{

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

    typedef T ValueType;  

    static const char* typeName();

    JDSStorage( const IndexType numRows, const IndexType numColumns );

    JDSStorage( const IndexType numRows, 
                const IndexType numColumns,
                const IndexType numValues,
                const IndexType numDiagonals,
                const LAMAArray<IndexType>& dlg,
                const LAMAArray<IndexType>& ilg,
                const LAMAArray<IndexType>& perm,
                const LAMAArray<IndexType>& ja,
                const LAMAArray<ValueType>& values  );

    JDSStorage();

    JDSStorage( const JDSStorage<ValueType>& other );

    explicit JDSStorage( const _MatrixStorage& other );

    JDSStorage( const _MatrixStorage& other, const ContextPtr context );

    JDSStorage<ValueType>& operator=( const JDSStorage<ValueType>& other);

    JDSStorage<ValueType>& operator=( const _MatrixStorage& other);

    virtual JDSStorage* copy() const;

    virtual JDSStorage* create() const;

    virtual void clear();

    virtual ~JDSStorage();

    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 matrixTimesVector(
        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 writeAt( std::ostream& stream ) const;

    const LAMAArray<IndexType>& getJA() const;

    const LAMAArray<IndexType>& getPerm() const;

    const LAMAArray<IndexType>& getDlg() const;

    const LAMAArray<IndexType>& getIlg() const;

    const LAMAArray<ValueType>& getValues() const;

    IndexType getNumDiagonals() const;

    virtual IndexType getNumValues() 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 );

    /******************************************************************
    *  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;

    void swap( JDSStorage<ValueType>& other );

    virtual size_t getMemoryUsageImpl() const;

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

protected:

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

    IndexType mNumDiagonals;         
    IndexType mNumValues;            

    LAMAArray<IndexType> mDlg;       
    LAMAArray<IndexType> mIlg;       
    LAMAArray<IndexType> mPerm;      
    LAMAArray<IndexType> mJa;        
    LAMAArray<ValueType> mValues;    

private:

    void assignJDS( const JDSStorage<ValueType>& other );

    virtual bool checkDiagonalProperty() const;

    void sortRows( ContextPtr loc );

    void setupData( ContextPtr loc );

    /*
     * NOT USED ANYMORE
    void setCompressJDS( const JDSStorage<ValueType>& other );
    */

    void print() const;

    LAMA_LOG_DECL_STATIC_LOGGER( logger );  
};

}  // namespace lama

#endif // LAMA_JDSSTORAGE_HPP_