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
      91
<doc  92
      93
<doc  94
      95
      96
      97
      98

      99
<doc 100
     101
<doc 102
     103

     104
<doc 105
     106
     107
     108
<doc 109
     110

     111
<doc 112
     113

     114
     115
     116
<doc 117
     118

     119
<doc 120
     121

     122
<doc 123
     124

     125
<doc 126
     127

     128
<doc 129
     130

     131
<doc 132
     133

     134
<doc 135
     136

     137
<doc 138
     139

     140
<doc 141
     142

     143
<doc 144
     145

     146
<doc 147
     148

     149
<doc 150
     151

     152
<doc 153
     154

     155
<doc 156
     157

     158
<doc 159
     160

     161
<doc 162
     163

     164
<doc 165
     166

     167
<doc 168
     169
     170
     171
     172

     173
<doc 174
     175
     176

     177
<doc 178
     179

     180
<doc 181
     182

     183
     184
     185
     186
     187
<doc 188
     189

     190
<doc 191
     192

     193
     194
<doc 195
     196
     197

     198
<doc 199
     200
     201

     202
<doc 203
     204

     205
<doc 206
     207

     208
     209
<doc 210
     211
     212

     213
<doc 214
     215
     216

     217
<doc 218
     219
     220
     221
     222

     223
<doc 224
     225
     226
     227
     228

     229
     230
<doc 231
     232
     233

     234
<doc 235
     236
     237

     238
<doc 239
     240
     241
     242

     243
<doc 244
     245
     246
     247

     248
     249
<doc 250
     251

     252
<doc 253
     254

     255
     256
     257
<doc 258
     259

     260
<doc 261
     262

     263
<doc 264
     265

     266
<doc 267
     268

     269
     270
     271
     272
     273
     274
     275
     276
     277
     278
     279
/*
 *   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_BANDSTORAGE_H
#define FLENS_STORAGE_BANDSTORAGE_BANDSTORAGE_H 1

#include <flens/storage/indexoptions.h>
#include <flens/typedefs.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 BandStorageView;

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

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 = ColMajor,
          typename I = IndexOptions<>,
          typename A = std::allocator<T> >
class BandStorage
{
    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<T, Order, I, A>  ConstView;
        typedef BandStorageView<T, Order, I, A>       View;
        typedef BandStorage                           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;

        BandStorage();

        BandStorage(IndexType numRows, IndexType numCols,
                    IndexType numSubDiags, IndexType numSuperDiags,
                    IndexType firstIndex = I::defaultIndexBase,
                    const ElementType &value = ElementType(),
                    const Allocator &allocator = Allocator());

        BandStorage(const BandStorage &rhs);

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

        ~BandStorage();

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

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

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

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

        ElementType *
        data();

        const Allocator &
        allocator() const;

        bool
        resize(IndexType numRows, IndexType numCols,
               IndexType numSubDiags, IndexType numSuperDiags,
               IndexType firstIndex = I::defaultIndexBase,
               const ElementType &value = ElementType());

        template <typename FS>
            bool
            resize(const FS &rhs, const ElementType &value = ElementType());

        bool
        fill(const ElementType &value = ElementType(0));

        bool
        fillRandom();

        void
        changeIndexBase(IndexType firstIndex);

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

        ArrayView
        arrayView(IndexType firstViewIndex = I::defaultIndexBase);

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

        ArrayView
        viewDiag(IndexType diag,
                 IndexType firstViewIndex = I::defaultIndexBase);

        const ConstView
        viewDiags(IndexType fromDiag, IndexType toDiag) const;

        View
        viewDiags(IndexType fromDiag, IndexType toDiag);

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

        ArrayView
        viewRow(IndexType row,
                IndexType firstViewIndex = I::defaultIndexBase);

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

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

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

        ArrayView
        viewCol(IndexType col,
            IndexType firstViewIndex = I::defaultIndexBase);

        const ConstArrayView
        viewCol(IndexType firstRow, IndexType lastRow,
                IndexType stride, IndexType col,
                IndexType firstViewIndex = I::defaultIndexBase) const;

        ArrayView
        viewCol(IndexType firstRow, IndexType lastRow,
                IndexType stride, IndexType col,
                IndexType firstViewIndex = I::defaultIndexBase);

        // view to underlying FullStorage
        const ConstFullStorageView
        viewFullStorage() const;

        FullStorageView
        viewFullStorage();

    private:

        void
        setIndexBase_(IndexType firstIndex);

        void
        raw_allocate_();

        void
        allocate_(const ElementType &value = ElementType());

        void
        release_();

        ElementType  *data_;
        Allocator    allocator_;
        IndexType    numRows_, numCols_;
        IndexType    numSubDiags_, numSuperDiags_;
        IndexType    firstIndex_;
};

// namespace flens

#endif // FLENS_STORAGE_BANDSTORAGE_BANDSTORAGE_H