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
      57
      58
      59
      60
      61
      62
      63
      64
<doc  65
      66
      67
      68
      69
      70

      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
      89
      90
<doc  91
      92
      93
      94
      95
      96

      97
      98
<doc  99
     100
<doc 101
     102

     103
<doc 104
     105
     106
     107
<doc 108
     109

     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
<doc 146
     147

     148
<doc 149
     150

     151
<doc 152
     153

     154
<doc 155
     156

     157
<doc 158
     159

     160
<doc 161
     162

     163
     164
<doc 165
     166

     167
     168
<doc 169
     170
     171

     172
     173
<doc 174
     175

     176
     177
<doc 178
     179
     180

     181
<doc 182
     183
     184
     185
     186

     187
     188
     189
<doc 190
     191
     192

     193
<doc 194
     195
     196
     197

     198
     199
     200
     201
     202
     203
     204
     205
     206
     207
     208
     209
     210
/*
 *   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 <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 FullStorage;

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

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

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;

        typedef flens::ConstFullStorageView<T,Order,I,A>   ConstFullStorageView;
        typedef flens::FullStorageView<T,Order,I,A>        FullStorageView;
        typedef flens::FullStorage<T,Order,I,A>            FullStorage;

        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;

        IndexType
        strideRow() const;

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

        // view of single row
        const ConstArrayView
        viewRow(IndexType row,
                IndexType firstViewIndex = I::defaultIndexBase) const;

        const ConstArrayView
        viewRow(IndexType row,
                IndexType firstCol, IndexType lastCol,
                IndexType stride,
                IndexType firstViewIndex = I::defaultIndexBase) const;


        // view of single col
        const ConstArrayView
        viewCol(IndexType col,
                IndexType firstViewIndex = I::defaultIndexBase) const;

        const ConstArrayView
        viewCol(IndexType firstRow, IndexType lastRow,
                IndexType stride, IndexType col,
                IndexType firstViewIndex = I::defaultIndexBase) 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