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
<doc  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
      89
      90
      91
      92
      93
      94
      95
      96
      97
<doc  98
      99
<doc 100
     101
     102

     103
<doc 104
     105
<doc 106
     107
<doc 108
     109

     110
<doc 111
     112

     113
<doc 114
     115

     116
     117
     118
<doc 119
     120

     121
<doc 122
     123
     124

     125
<doc 126
     127
     128

     129
<doc 130
     131
     132

     133
<doc 134
     135

     136
<doc 137
     138

     139
<doc 140
     141

     142
<doc 143
     144

     145
<doc 146
     147

     148
<doc 149
     150

     151
<doc 152
     153

     154
     155
     156
     157
<doc 158
     159

     160
<doc 161
     162

     163
     164
<doc 165
     166

     167
<doc 168
     169

     170
     171
<doc 172
     173

     174
<doc 175
     176

     177
<doc 178
     179

     180
<doc 181
     182

     183
     184
     185
<doc 186
     187

     188
<doc 189
     190

     191
<doc 192
     193

     194
<doc 195
     196

     197
<doc 198
     199

     200
<doc 201
     202

     203
<doc 204
     205

     206
<doc 207
     208

     209
<doc 210
     211

     212
<doc 213
     214

     215
<doc 216
     217
     218
     219

     220
<doc 221
     222
     223
     224

     225
<doc 226
     227

     228
<doc 229
     230

     231
     232
     233
<doc 234
     235

     236
<doc 237
     238

     239
<doc 240
     241

     242
     243
     244
     245
     246
     247
     248
     249
     250
     251
<doc 252
     253

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

     271
     272
     273
     274
     275
     276
     277
/*
 *   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_HBMATRIX_H
#define FLENS_MATRIXTYPES_HERMITIAN_IMPL_HBMATRIX_H 1

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

namespace flens {

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

template <typename FS>
    class GbMatrix;

template <typename FS>
    class HbMatrix;

template <typename FS>
    class SbMatrix;

template <typename FS>
    class TbMatrix;

template <typename FS>
class HbMatrix
    : public HermitianMatrix<HbMatrix<FS> >
{
    public:
        typedef FS                                  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 GbMatrix<EngineConstView>           ConstGeneralView;
        typedef GbMatrix<EngineView>                GeneralView;
        typedef GbMatrix<EngineNoView>              GeneralNoView;

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

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

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

        HbMatrix();

        explicit
        HbMatrix(IndexType dim, StorageUpLo upLo, IndexType numOffDiags,
                 IndexType firstIndex = Engine::defaultIndexBase);

        HbMatrix(const Engine &engine, StorageUpLo upLo);

        HbMatrix(const HbMatrix &rhs);

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

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

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

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

        HbMatrix &
        operator=(const HbMatrix &rhs);

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

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

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

        HbMatrix<FS> &
        operator=(const ElementType &alpha);

        HbMatrix<FS> &
        operator+=(const ElementType &alpha);

        HbMatrix<FS> &
        operator-=(const ElementType &alpha);

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

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

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

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

        // -- views ------------------------------------------------------------

        // general views
        ConstGeneralView
        general() const;

        GeneralView
        general();

        // symmetric view
        ConstSymmetricView
        symmetric() const;

        SymmetricView
        symmetric();

        // triangular view
        ConstTriangularView
        triangular() const;

        TriangularView
        triangular();

        VectorView
        diag(IndexType diag);

        const ConstVectorView
        diag(IndexType diag) const;

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

        IndexType
        dim() const;

        IndexType
        numCols() const;

        IndexType
        numRows() const;

        IndexType
        firstIndex() const;

        IndexType
        lastIndex() const;

        IndexType
        leadingDimension() const;

        StorageOrder
        order() const;

        IndexType
        numOffDiags() const;

        const ElementType *
        data() const;

        ElementType *
        data();

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

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

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

        bool
        fillRandom();

        // -- implementation ---------------------------------------------------

        const Engine &
        engine() const;

        Engine &
        engine();

        StorageUpLo
        upLo() const;

    private:
        Engine       engine_;
        StorageUpLo  upLo_;
};

//-- Traits --------------------------------------------------------------------
//
//  IsHbMatrix
//
struct HbMatrixChecker_
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(AnyConversion_);

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

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

// namespace flens

#endif // FLENS_MATRIXTYPES_HERMITIAN_IMPL_HBMATRIX_H