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
<doc  83
      84
      85
      86
      87

      88
<doc  89
      90
<doc  91
      92

      93
<doc  94
      95
      96
      97
<doc  98
      99

     100
     101
     102
<doc 103
     104

     105
<doc 106
     107

     108
<doc 109
     110

     111
<doc 112
     113

     114
<doc 115
     116

     117
<doc 118
     119

     120
     121
     122
     123
     124
     125
     126
     127
     128
     129
     130
     131
/*
 *   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_PACKEDSTORAGE_CONSTPACKEDSTORAGEVIEW_H
#define FLENS_STORAGE_PACKEDSTORAGE_CONSTPACKEDSTORAGEVIEW_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 PackedStorage;

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

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

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

        typedef ConstPackedStorageView               ConstView;
        typedef PackedStorageView<T, Order, I, A>    View;
        typedef PackedStorage<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;

        ConstPackedStorageView(IndexType dim,
                               const ElementType *data,
                               IndexType indexBase = I::defaultIndexBase,
                               const Allocator &allocator = Allocator());

        template <typename ARRAY>
            ConstPackedStorageView(IndexType dim,
                                   ARRAY &array,
                                   IndexType indexBase = I::defaultIndexBase,
                                   const Allocator &allocator = Allocator());

        ConstPackedStorageView(const ConstPackedStorageView &rhs);

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

        ~ConstPackedStorageView();

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

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

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

        IndexType
        indexBase() const;

        IndexType
        numNonZeros() const;

        IndexType
        dim() const;

        const ElementType *
        data() const;

        const Allocator &
        allocator() const;

        void
        changeIndexBase(IndexType indexBase);


    private:
        const ElementType    *data_;
        Allocator            allocator_;
        IndexType            dim_;
        IndexType            indexBase_;
};

// namespace flens

#endif // FLENS_STORAGE_PACKEDSTORAGE_CONSTPACKEDSTORAGEVIEW_H