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
<doc  56
      57
      58
      59
      60
      61

      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
<doc  78
      79
      80
      81
      82
      83
      84

      85
<doc  86
      87
      88
      89
      90
      91
      92
      93

      94
<doc  95
      96
<doc  97
      98

      99
<doc 100
     101
     102
     103
<doc 104
     105

     106
<doc 107
     108

     109
     110
     111
<doc 112
     113

     114
<doc 115
     116

     117
<doc 118
     119

     120
<doc 121
     122

     123
<doc 124
     125

     126
<doc 127
     128

     129
<doc 130
     131

     132
<doc 133
     134

     135
<doc 136
     137

     138
<doc 139
     140

     141
<doc 142
     143

     144
<doc 145
     146

     147
<doc 148
     149

     150
<doc 151
     152
     153
     154
     155

     156
<doc 157
     158
     159

     160
<doc 161
     162

     163
<doc 164
     165
     166

     167
<doc 168
     169

     170
     171
<doc 172
     173

     174
<doc 175
     176

     177
     178
<doc 179
     180
     181
     182
     183
     184
     185

     186
<doc 187
     188
     189
     190
     191
     192
     193

     194
     195
<doc 196
     197
     198

     199
<doc 200
     201
     202

     203
<doc 204
     205
     206
     207
     208

     209
<doc 210
     211
     212
     213
     214

     215
     216
<doc 217
     218
     219

     220
<doc 221
     222
     223

     224
<doc 225
     226
     227
     228

     229
<doc 230
     231
     232
     233

     234
     235
<doc 236
     237
     238

     239
<doc 240
     241
     242

     243
     244
<doc 245
     246
     247

     248
<doc 249
     250
     251

     252
     253
     254
     255
     256
     257
     258
     259
     260
     261
     262
     263
     264
     265
     266
<doc 267
     268
     269

     270
<doc 271
     272
     273
     274

     275
     276
     277
     278
     279
/*
 *   Copyright (c) 2007,2015 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_FULLSTORAGE_FULLSTORAGEVIEW_H
#define FLENS_STORAGE_FULLSTORAGE_FULLSTORAGEVIEW_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 FullStorage;

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

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

        static const StorageOrder       noViewOrder      = NoViewOrder;
        static const IndexType          defaultIndexBase = I::defaultIndexBase;

        typedef ConstFullStorageView<T, NoViewOrder, I, A>  ConstView;
        typedef FullStorageView                             View;
        typedef FullStorage<T, NoViewOrder, I, A>           NoView;

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

        FullStorageView(IndexType       numRows,
                        IndexType       numCols,
                        IndexType       leadingDimension,
                        ElementType     *data,
                        IndexType       firstRow = I::defaultIndexBase,
                        IndexType       firstCol = I::defaultIndexBase,
                        const Allocator &allocator = Allocator());

        FullStorageView(IndexType       numRows,
                        IndexType       numCols,
                        ElementType     *data,
                        IndexType       strideRow,
                        IndexType       strideCol,
                        IndexType       firstRow = I::defaultIndexBase,
                        IndexType       firstCol = I::defaultIndexBase,
                        const Allocator &allocator = Allocator());

        FullStorageView(const FullStorageView &rhs);

        template <typename RHS>
            FullStorageView(RHS &rhs);

        ~FullStorageView();

        //-- 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
        numRows() const;

        IndexType
        numCols() const;

        StorageOrder
        order() 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 firstRow = I::defaultIndexBase,
               IndexType firstCol = 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
        fill(StorageUpLo  upLo,
             const ElementType &value = ElementType(0));

        void
        changeIndexBase(IndexType firstRow, IndexType firstCol);

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

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

        // view of rectangular part
        const ConstView
        view(IndexType fromRow, IndexType fromCol,
             IndexType toRow, IndexType toCol,
             IndexType strideRow = IndexType(1),
             IndexType strideCol = IndexType(1),
             IndexType firstViewRow = I::defaultIndexBase,
             IndexType firstViewCol = I::defaultIndexBase) const;

        View
        view(IndexType fromRow, IndexType fromCol,
             IndexType toRow, IndexType toCol,
             IndexType strideRow = IndexType(1),
             IndexType strideCol = IndexType(1),
             IndexType firstViewRow = I::defaultIndexBase,
             IndexType firstViewCol = I::defaultIndexBase);

        // 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 column
        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 of d-th diagonal
        const ConstArrayView
        viewDiag(IndexType d,
                 IndexType firstViewIndex = I::defaultIndexBase) const;

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

        // view of d-th anti-diagonal
        const ConstArrayView
        viewAntiDiag(IndexType d,
                 IndexType firstViewIndex = I::defaultIndexBase) const;

        ArrayView
        viewAntiDiag(IndexType d,
                     IndexType firstViewIndex = I::defaultIndexBase);

    private:
        ElementType  *data_;
        Allocator    allocator_;
        IndexType    numRows_, numCols_;
        IndexType    strideRow_, strideCol_;
        IndexType    firstRow_, firstCol_;
};

//-- FullStorageView specific functions ----------------------------------------

//
//  fillRandom
//

template <typename T, StorageOrder NoViewOrder, typename I, typename Allocator>
    bool
    fillRandom(FullStorageView<T, NoViewOrder, I, Allocator> &A);

template <typename T, StorageOrder NoViewOrder, typename I, typename Allocator>
    bool
    fillRandom(StorageUpLo upLo,
               FullStorageView<T, NoViewOrder, I, Allocator> &A);


// namespace flens

#endif // FLENS_STORAGE_FULLSTORAGE_FULLSTORAGEVIEW_H