crs.h (flens/storage/crs/crs.h)

       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
<doc 46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
<doc 57
      58
<doc 59
      60
      61
      62
<doc 63
      64
      65
      66
      67
      68
<doc 69
      70
      71
<doc 72
      73
      74
<doc 75
      76
      77
<doc 78
      79
      80
<doc 81
      82
      83
<doc 84
      85
      86
<doc 87
      88
      89
<doc 90
      91
      92
<doc 93
      94
      95
<doc 96
      97
      98
<doc 99
     100
     101
<doc 102
     103
     104
<doc 105
     106
     107
<doc 108
     109
     110
<doc 111
     112
     113
     114
     115
     116
     117
     118
     119
     120
     121
     122
     123
     124
     125
     126
     127
     128
     129
     130

/*
*   Copyright (c) 2007-2012, Michael Lehn
*
*   All rights reserved.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   1) Redistributions of source code must retain the above copyright
*      notice, this list of conditions and the following disclaimer.
*   2) Redistributions in binary form must reproduce the above copyright
*      notice, this list of conditions and the following disclaimer in
*      the documentation and/or other materials provided with the
*      distribution.
*   3) Neither the name of the FLENS development group nor the names of
*      its contributors may be used to endorse or promote products derived
*      from this software without specific prior written permission.
*
*   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
*   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
*   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
*   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
*   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
*   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
*   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
*   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef FLENS_STORAGE_CRS_CRS_H
#define FLENS_STORAGE_CRS_CRS_H 1

#include <vector>

#include <flens/vectortypes/impl/densevector.h>
#include <flens/storage/array/array.h>
#include <flens/storage/coordstorage/coordstorage.h>
#include <flens/storage/indexoptions.h>

namespace flens {

template <typename T,
          typename I = IndexOptions<> >
class CRS
{
    public:
        typedef T                                   ElementType;
        typedef typename I::IndexType               IndexType;

        typedef DenseVector<Array<ElementType> >    ElementTypeVector;
        typedef DenseVector<Array<IndexType> >      IndexTypeVector;

        CRS();

        ~CRS();

        //-- operators ---------------------------------------------------------

        template <typename T2, typename I2>
            void
            operator=(const CoordStorage<T2, CoordRowColCmp, I2> &coordStorage);

        //-- methods -----------------------------------------------------------

        const IndexType
        indexBase() const;

        const IndexType
        firstRow() const;

        const IndexType
        lastRow() const;

        const IndexType
        firstCol() const;

        const IndexType
        lastCol() const;

        const IndexType
        numRows() const;

        const IndexType
        numCols() const;

        const IndexType
        numNonZeros() const;

        const IndexTypeVector &
        rows() const;

        IndexTypeVector &
        rows();

        const IndexTypeVector &
        cols() const;

        IndexTypeVector &
        cols();

        const ElementTypeVector &
        values() const;

        ElementTypeVector &
        values();

        template <typename T2, typename I2>
            void
            _compress(const CoordStorage<T2, CoordRowColCmp, I2> &coordStorage);

    private:
        // Lehn:  I do not allow copying matrices with crs unless someone gives
        //        me a reason.
        CRS(const CRS &rhs);

        IndexType  _numRows, _numCols;
        IndexType  _indexBase;

        DenseVector<Array<IndexType> >  _rows;
        DenseVector<Array<IndexType> >  _cols;
        DenseVector<Array<T> >          _values;
};

} // namespace flens

#endif // FLENS_STORAGE_CRS_CRS_H