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
<doc  52
      53
      54
      55

      56
      57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
<doc  89
      90
<doc  91
      92
<doc  93
      94
<doc  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

     115
<doc 116
     117
     118

     119
<doc 120
     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
     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
<doc 171
     172

     173
<doc 174
     175

     176
<doc 177
     178

     179
<doc 180
     181

     182
<doc 183
     184

     185
<doc 186
     187
     188
     189

     190
<doc 191
     192
     193
     194

     195
     196
     197
     198
<doc 199
     200

     201
<doc 202
     203

     204
     205
<doc 206
     207

     208
<doc 209
     210

     211
     212
<doc 213
     214

     215
<doc 216
     217

     218
     219
     220
<doc 221
     222

     223
<doc 224
     225

     226
     227
     228
     229
     230
     231
     232
     233
     234
     235
<doc 236
     237

     238
<doc 239
     240
     241
     242
     243
     244
     245
     246
     247
     248
     249
     250
     251
<doc 252
     253
     254

     255
     256
     257
     258
     259
     260
     261
/*
 *   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_MATRIXTYPES_HERMITIAN_IMPL_HPMATRIX_H
#define FLENS_MATRIXTYPES_HERMITIAN_IMPL_HPMATRIX_H 1

#include <flens/auxiliary/auxiliary.h>
#include <flens/typedefs.h>
#include <flens/matrixtypes/hermitian/hermitianmatrix.h>

namespace flens {

// forward declarations
template <typename A>
    class DenseVector;

template <typename PS>
    class SpMatrix;

template <typename PS>
    class TpMatrix;

template <typename PS>
class HpMatrix
    : public HermitianMatrix<HpMatrix<PS> >
{
    public:
        typedef PS                                  Engine;
        typedef typename Engine::ElementType        ElementType;
        typedef typename Engine::IndexType          IndexType;

        // view types from Engine
        typedef typename Engine::ConstView          EngineConstView;
        typedef typename Engine::View               EngineView;
        typedef typename Engine::NoView             EngineNoView;

        typedef typename Engine::ConstArrayView     ConstArrayView;
        typedef typename Engine::ArrayView          ArrayView;
        typedef typename Engine::Array              Array;

        // view types
        typedef DenseVector<ConstArrayView>         ConstVectorView;
        typedef DenseVector<ArrayView>              VectorView;
        typedef DenseVector<Array>                  Vector;

        typedef HpMatrix<EngineConstView>           ConstView;
        typedef HpMatrix<EngineView>                View;
        typedef HpMatrix<EngineNoView>              NoView;

        typedef SpMatrix<EngineConstView>           ConstSymmetricView;
        typedef SpMatrix<EngineView>                SymmetricView;
        typedef SpMatrix<EngineNoView>              SymmetricNoView;

        typedef TpMatrix<EngineConstView>           ConstTriangularView;
        typedef TpMatrix<EngineView>                TriangularView;
        typedef TpMatrix<EngineNoView>              TriangularNoView;

        //-- Constructors ------------------------------------------------------

        HpMatrix(IndexType dim, StorageUpLo upLo = Upper);

        HpMatrix(const Engine &engine, StorageUpLo upLo);

        HpMatrix(const HpMatrix &rhs);

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

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

        template <typename RHS>
            HpMatrix(const Matrix<RHS> &rhs);

        //-- Operators ---------------------------------------------------------

        HpMatrix &
        operator=(const ElementType &alpha);

        HpMatrix &
        operator=(const HpMatrix &rhs);

        template <typename RHS>
            HpMatrix &
            operator=(const Matrix<RHS> &rhs);

        template <typename RHS>
            HpMatrix &
            operator+=(const Matrix<RHS> &rhs);

        template <typename RHS>
            HpMatrix &
            operator-=(const Matrix<RHS> &rhs);

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

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

        HpMatrix &
        operator+=(const ElementType &alpha);

        HpMatrix &
        operator-=(const ElementType &alpha);

        HpMatrix &
        operator*=(const ElementType &alpha);

        HpMatrix &
        operator/=(const ElementType &alpha);

        //-- Methods -----------------------------------------------------------

        IndexType
        numRows() const;

        IndexType
        numCols() const;

        IndexType
        dim() const;

        IndexType
        firstRow() const;

        IndexType
        lastRow() const;

        IndexType
        firstCol() const;

        IndexType
        lastCol() const;

        IndexType
        indexBase() const;

        StorageUpLo
        upLo() const;

        StorageUpLo &
        upLo();

        const ElementType *
        data() const;

        ElementType *
        data();

        StorageOrder
        order() const;

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

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

        bool
        resize(IndexType dim,
               IndexType indexBase = Engine::defaultIndexBase,
               const ElementType &value = ElementType());

        //-- Views -------------------------------------------------------------

        // hermitian views
        const ConstView
        hermitian() const;

        View
        hermitian();

        // symmetric view
        const ConstSymmetricView
        symmetric() const;

        SymmetricView
        symmetric();

        // triangular view
        const ConstTriangularView
        triangular() const;

        TriangularView
        triangular();

        //-- Implementation ----------------------------------------------------

        const Engine &
        engine() const;

        Engine &
        engine();

    private:
        Engine       engine_;
        StorageUpLo  upLo_;
};

//-- Traits --------------------------------------------------------------------
//
//  IsHpMatrix
//
struct HpMatrixChecker_
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(AnyConversion_);

    template <typename Any>
        static char
        check(HpMatrix<Any>);
};

template <typename T>
struct IsHpMatrix
{
    static T var;
    static const bool value = sizeof(HpMatrixChecker_::check(var))==1;
};

// namespace flens

#endif // FLENS_MATRIXTYPES_HERMITIAN_IMPL_HPMATRIX_H