packedstorageview.h (flens/storage/packedstorage/packedstorageview.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
<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
<doc 101
     102
     103
     104
     105
<doc 106
     107
     108
<doc 109
     110
     111
<doc 112
     113
     114
<doc 115
     116
     117
<doc 118
     119
     120
<doc 121
     122
     123
<doc 124
     125
     126
     127
     128
<doc 129
     130
     131
<doc 132
     133
     134
     135
     136
     137
     138
     139
     140
     141
     142
     143
     144

/*

 *   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_PACKEDSTORAGEVIEW_H

#define FLENS_STORAGE_PACKEDSTORAGE_PACKEDSTORAGEVIEW_H

#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 ConstPackedStorageView;

template <typename T,

          StorageOrder Order = ColMajor,

          typename I = IndexOptions<>,

          typename A = std::allocator<T> >

class PackedStorageView

{

    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<T, Order, I, A>  ConstView;

        typedef PackedStorageView                       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;

        PackedStorageView(IndexType dim,

                          ElementType *data,

                          IndexType indexBase = I::defaultIndexBase,

                          const Allocator &allocator = Allocator());

        template <typename ARRAY>

            PackedStorageView(IndexType dim,

                              ARRAY &array,

                              IndexType indexBase = I::defaultIndexBase,

                              const Allocator &allocator = Allocator());

        PackedStorageView(const PackedStorageView &rhs);

        template <typename RHS>

            PackedStorageView(RHS &rhs);

        ~PackedStorageView();

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

        const ElementType &

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

        ElementType &

        operator()(StorageUpLo upLo, IndexType row, IndexType col);

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

        IndexType

        indexBase() const;

        IndexType

        numNonZeros() const;

        IndexType

        dim() const;

        const ElementType *

        data() const;

        ElementType *

        data();

        const Allocator &

        allocator() const;

        bool

        resize(IndexType dim,

               IndexType indexBase = I::defaultIndexBase,

               const ElementType &value = ElementType());

        bool

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

        void

        changeIndexBase(IndexType indexBase);

    private:

        ElementType  *data_;

        Allocator    allocator_;

        IndexType    dim_;

        IndexType    indexBase_;

};

} // namespace flens

#endif // FLENS_STORAGE_PACKEDSTORAGE_PACKEDSTORAGEVIEW_H