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

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

     110
<doc 111
     112

     113
<doc 114
     115

     116
     117
<doc 118
     119

     120
<doc 121
     122

     123
<doc 124
     125
     126

     127
<doc 128
     129
     130

     131
<doc 132
     133
     134

     135
<doc 136
     137

     138
<doc 139
     140

     141
     142
<doc 143
     144
     145

     146
<doc 147
     148
     149

     150
     151
<doc 152
     153
     154

     155
<doc 156
     157
     158

     159
     160
<doc 161
     162
     163

     164
<doc 165
     166
     167

     168
     169
<doc 170
     171

     172
<doc 173
     174

     175
<doc 176
     177

     178
<doc 179
     180

     181
     182
<doc 183
     184

     185
<doc 186
     187

     188
<doc 189
     190

     191
<doc 192
     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
<doc 220
     221

     222
<doc 223
     224

     225
<doc 226
     227

     228
<doc 229
     230

     231
<doc 232
     233

     234
<doc 235
     236

     237
<doc 238
     239
     240
     241

     242
<doc 243
     244
     245
     246

     247
<doc 248
     249
     250
     251
     252

     253
     254
     255
<doc 256
     257

     258
<doc 259
     260

     261
     262
<doc 263
     264

     265
<doc 266
     267

     268
     269
<doc 270
     271

     272
<doc 273
     274

     275
     276
<doc 277
     278

     279
<doc 280
     281

     282
     283
<doc 284
     285

     286
<doc 287
     288

     289
<doc 290
     291

     292
<doc 293
     294

     295
     296
     297
     298
     299
     300
     301
     302
     303
     304
<doc 305
     306

     307
<doc 308
     309
     310
     311
     312
     313
     314
     315
     316
     317
     318
     319
     320
<doc 321
     322
     323

     324
     325
     326
     327
     328
     329
     330
     331
     332
     333
<doc 334
     335
     336
     337

     338
     339
     340
     341
     342
/*
 *   Copyright (c) 2007, Michael Lehn
 *
 *   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_HEMATRIX_H
#define FLENS_MATRIXTYPES_HERMITIAN_IMPL_HEMATRIX_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 FS>
    class GeMatrix;

template <typename FS>
    class SyMatrix;

template <typename FS>
    class TrMatrix;

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

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

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

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

        // -- constructors -----------------------------------------------------
        HeMatrix(StorageUpLo upLo=Upper);

        HeMatrix(IndexType dim, StorageUpLo upLo);

        HeMatrix(IndexType dim, IndexType firstIndex, StorageUpLo upLo);

        HeMatrix(IndexType dim, IndexType firstRow, IndexType firstCol,
                 StorageUpLo upLo);

        HeMatrix(const Engine &engine, StorageUpLo upLo);

        HeMatrix(const HeMatrix &rhs);

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

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

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

        // -- operators --------------------------------------------------------
        void
        operator=(const ElementType &value);

        HeMatrix &
        operator=(const HeMatrix &rhs);

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

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

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

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

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

        // rectangular views
        const ConstGeneralView
        operator()(const Range<IndexType> &rows,
                   const Range<IndexType> &cols) const;

        GeneralView
        operator()(const Range<IndexType> &rows,
                   const Range<IndexType> &cols);

        // rectangular views (all rows selected)
        const ConstGeneralView
        operator()(const Underscore<IndexType> &,
                   const Range<IndexType> &cols) const;

        GeneralView
        operator()(const Underscore<IndexType> &,
                   const Range<IndexType> &cols);

        // rectangular views (all columns selected)
        const ConstGeneralView
        operator()(const Range<IndexType> &rows,
                   const Underscore<IndexType> &) const;

        GeneralView
        operator()(const Range<IndexType> &rows,
                   const Underscore<IndexType> &);

        // row view (vector view)
        const ConstVectorView
        operator()(IndexType row, const Underscore<IndexType> &) const;

        VectorView
        operator()(IndexType row, const Underscore<IndexType> &);

        const ConstVectorView
        operator()(IndexType row, const Range<IndexType> &cols) const;

        VectorView
        operator()(IndexType row, const Range<IndexType> &cols);

        // column view (vector view)
        const ConstVectorView
        operator()(const Underscore<IndexType> &, IndexType col) const;

        VectorView
        operator()(const Underscore<IndexType> &, IndexType col);

        const ConstVectorView
        operator()(const Range<IndexType> &rows, IndexType col) const;

        VectorView
        operator()(const Range<IndexType> &rows, IndexType col);

        // -- methods ----------------------------------------------------------
        IndexType
        dim() const;

        IndexType
        numRows() const;

        IndexType
        numCols() const;

        IndexType
        firstRow() const;

        IndexType
        lastRow() const;

        IndexType
        firstCol() const;

        IndexType
        lastCol() const;

        const ElementType *
        data() const;

        ElementType *
        data();

        IndexType
        leadingDimension() const;

        IndexType
        strideRow() const;

        IndexType
        strideCol() const;

        StorageOrder
        order() const;

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

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

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

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

        // -- views ------------------------------------------------------------
        // general views
        const ConstGeneralView
        general() const;

        GeneralView
        general();

        // symmetric views
        const ConstSymmetricView
        symmetric() const;

        SymmetricView
        symmetric();

        // triangular views
        const ConstTriangularView
        triangular() const;

        TriangularView
        triangular();

        // diag views
        const ConstVectorView
        diag(IndexType d) const;

        VectorView
        diag(IndexType d);

        // -- implementation ---------------------------------------------------
        const Engine &
        engine() const;

        Engine &
        engine();

        StorageUpLo
        upLo() const;

        StorageUpLo &
        upLo();

    private:
        Engine      engine_;
        StorageUpLo upLo_;
};

//-- Traits --------------------------------------------------------------------
//
//  IsHeMatrix
//
struct HeMatrixChecker_
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(AnyConversion_);

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

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

//-- HeMatrix specific functions -----------------------------------------------

//
//  fillRandom
//

template <typename MA>
    typename RestrictTo<IsHeMatrix<MA>::value,
             bool>::Type
    fillRandom(MA &&A);


// namespace flens

#endif // FLENS_MATRIXTYPES_HERMITIAN_IMPL_HEMATRIX_H