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
      59
<doc  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
      98
<doc  99
     100
<doc 101
     102
     103

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

     111
<doc 112
     113

     114
<doc 115
     116

     117
     118
     119
<doc 120
     121

     122
<doc 123
     124
     125

     126
<doc 127
     128
     129

     130
<doc 131
     132
     133

     134
<doc 135
     136

     137
<doc 138
     139

     140
<doc 141
     142

     143
<doc 144
     145

     146
<doc 147
     148

     149
<doc 150
     151

     152
<doc 153
     154

     155
     156
     157
     158
<doc 159
     160

     161
<doc 162
     163

     164
     165
<doc 166
     167

     168
<doc 169
     170

     171
     172
<doc 173
     174

     175
<doc 176
     177

     178
<doc 179
     180

     181
<doc 182
     183

     184
     185
     186
<doc 187
     188

     189
<doc 190
     191

     192
<doc 193
     194

     195
<doc 196
     197

     198
<doc 199
     200

     201
<doc 202
     203

     204
<doc 205
     206

     207
<doc 208
     209

     210
<doc 211
     212

     213
<doc 214
     215

     216
<doc 217
     218
     219
     220

     221
<doc 222
     223
     224
     225

     226
<doc 227
     228

     229
<doc 230
     231

     232
     233
     234
<doc 235
     236

     237
<doc 238
     239

     240
<doc 241
     242

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

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

     272
     273
     274
     275
     276
     277
     278
/*
 *   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 <cxxblas/typedefs.h>
#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
        viewDiag(IndexType diag = IndexType(0));

        const ConstVectorView
        viewDiag(IndexType diag = IndexType(0)) 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