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

Go to the documentation of this file.

#ifndef LAMA_COOSTORAGE_HPP_
#define LAMA_COOSTORAGE_HPP_

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

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

namespace lama
{

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

    typedef T ValueType; 

    static const char* typeName();

    COOStorage(const IndexType numRows, const IndexType numColumns);

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

    COOStorage();

    COOStorage( const COOStorage<ValueType>& other );

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

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

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

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

    virtual void clear();

    virtual ~COOStorage();

    void check( const char* msg ) const;

    virtual MatrixStorageFormat getFormat() const;

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

    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;

    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 );

    virtual void setDiagonalImpl( const Scalar scalar );

    virtual COOStorage* copy() const;

    virtual COOStorage* create() const;

    /******************************************************************
    *  Matrix times Vector                                            *
    ******************************************************************/

    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> matrixTimesVectorAsyncToDo(
        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;

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

    IndexType mNumValues; 

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

private:

    virtual bool checkDiagonalProperty() const;

    // values are stored in row-major order

    // TODO: index at irow / icolumn, not supported yet

    // inline IndexType index(IndexType irow, IndexType icolumn) const { return icolumn * mNumRows + irow; }

    LAMA_LOG_DECL_STATIC_LOGGER( logger );
};

} // namespace lama

#endif // LAMA_COOSTORAGE_HPP_