constbandstorageview.h (flens/storage/bandstorage/constbandstorageview.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
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
<doc 57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
<doc 79
      80
      81
      82
      83
      84
      85
      86
<doc 87
      88
<doc 89
      90
      91
<doc 92
      93
      94
      95
<doc 96
      97
      98
      99
     100
<doc 101
     102
     103
<doc 104
     105
     106
<doc 107
     108
     109
<doc 110
     111
     112
<doc 113
     114
     115
<doc 116
     117
     118
<doc 119
     120
     121
<doc 122
     123
     124
<doc 125
     126
     127
<doc 128
     129
     130
<doc 131
     132
     133
<doc 134
     135
     136
<doc 137
     138
     139
<doc 140
     141
     142
<doc 143
     144
     145
     146
<doc 147
     148
     149
     150
<doc 151
     152
     153
     154
     155
<doc 156
     157
     158
     159
     160
     161
     162
     163
     164
     165
     166
     167
     168
     169
     170

/*
*   Copyright (c) 2012, Michael Lehn, Klaus Pototzky
*
*   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_BANDSTORAGE_CONSTBANDSTORAGEVIEW_H
#define FLENS_STORAGE_BANDSTORAGE_CONSTBANDSTORAGEVIEW_H 1

#include <cxxblas/typedefs.h>
#include <flens/typedefs.h>
#include <flens/storage/indexoptions.h>

namespace flens {

template <typename T, typename I, typename A>
    class Array;

template <typename T, typename I, typename A>
    class ArrayView;

template <typename T, typename I, typename A>
    class ConstArrayView;

template <typename T, StorageOrder Order, typename I, typename A>
    class BandStorage;

template <typename T, StorageOrder Order, typename I, typename A>
    class BandStorageView;

template <typename T,
          StorageOrder Order,
          typename I = IndexOptions<>,
          typename A = std::allocator<T> >
class ConstBandStorageView
{
    public:
        typedef T                       ElementType;
        typedef typename I::IndexType   IndexType;
        typedef A                       Allocator;

        static const StorageOrder       order = Order;
        static const IndexType          defaultIndexBase = I::defaultIndexBase;

        typedef ConstBandStorageView                  ConstView;
        typedef BandStorageView<T, Order, I, A>       View;
        typedef BandStorage<T, Order, I, A>           NoView;

        typedef flens::ConstArrayView<T, I, A>        ConstArrayView;
        typedef flens::ArrayView<T, I, A>             ArrayView;
        typedef flens::Array<T, I, A>                 Array;

        ConstBandStorageView(IndexType numRows, IndexType numCols,
                             IndexType numSubDiags, IndexType numSuperDiags,
                             const ElementType *data,
                             IndexType leadingDimension,
                             IndexType firstIndex = I::defaultIndexBase,
                             const Allocator &allocator = Allocator());

        ConstBandStorageView(const ConstBandStorageView &rhs);

        template <typename RHS>
            ConstBandStorageView(const RHS &rhs);

        ~ConstBandStorageView();

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

        const ElementType &
        operator()(IndexType row, IndexType col) const;

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

        IndexType
        firstRow() const;

        IndexType
        lastRow() const;

        IndexType
        firstCol() const;

        IndexType
        lastCol() const;

        IndexType
        firstIndex() const;

        IndexType
        lastIndex() const;

        IndexType
        numRows() const;

        IndexType
        numCols() const;

        IndexType
        dim() const;

        IndexType
        numSubDiags() const;

        IndexType
        numSuperDiags() const;

        IndexType
        leadingDimension() const;

        const ElementType *
        data() const;

        const Allocator &
        allocator() const;

        void
        changeIndexBase(IndexType firstIndex);

        // view as an array
        const ConstArrayView
        arrayView(IndexType firstViewIndex = I::defaultIndexBase) const ;

        // view of a diagonal
        const ConstArrayView
        viewDiag(IndexType diag,
                 IndexType firstViewIndex = I::defaultIndexBase) const;

        // view of some diagonals
        const ConstView
        viewDiags(IndexType fromDiag, IndexType toDiag) const;

    private:
        const ElementType  *_data;
        Allocator            _allocator;
        IndexType            _numRows, _numCols;
        IndexType            _numSubDiags, _numSuperDiags;
        IndexType            _firstIndex;
        IndexType            _leadingDimension;
};

} // namespace flens

#endif // FLENS_STORAGE_BANDSTORAGE_CONSTBANDSTORAGEVIEW_H