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
<doc  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
      95
      96
<doc  97
      98
<doc  99
     100
<doc 101
     102
<doc 103
     104

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

     112
<doc 113
     114

     115
<doc 116
     117

     118
     119
<doc 120
     121

     122
<doc 123
     124

     125
<doc 126
     127
     128

     129
<doc 130
     131
     132

     133
<doc 134
     135
     136

     137
<doc 138
     139

     140
<doc 141
     142

     143
     144
<doc 145
     146
     147

     148
<doc 149
     150
     151

     152
     153
<doc 154
     155
     156

     157
<doc 158
     159
     160

     161
     162
<doc 163
     164
     165

     166
<doc 167
     168
     169

     170
     171
<doc 172
     173

     174
<doc 175
     176

     177
<doc 178
     179

     180
<doc 181
     182

     183
     184
<doc 185
     186

     187
<doc 188
     189

     190
<doc 191
     192

     193
<doc 194
     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
<doc 219
     220

     221
<doc 222
     223

     224
<doc 225
     226

     227
<doc 228
     229

     230
<doc 231
     232

     233
<doc 234
     235
     236
     237

     238
<doc 239
     240
     241
     242

     243
<doc 244
     245
     246
     247
     248

     249
     250
     251
<doc 252
     253

     254
<doc 255
     256

     257
     258
<doc 259
     260

     261
<doc 262
     263

     264
     265
<doc 266
     267

     268
<doc 269
     270

     271
     272
<doc 273
     274

     275
<doc 276
     277

     278
     279
<doc 280
     281

     282
<doc 283
     284

     285
<doc 286
     287

     288
<doc 289
     290

     291
     292
     293
     294
     295
     296
     297
     298
     299
     300
<doc 301
     302

     303
<doc 304
     305
     306
     307
     308
     309
     310
     311
     312
     313
     314
     315
     316
<doc 317
     318
     319

     320
     321
     322
     323
     324
     325
     326
<doc 327
     328
     329

     330
     331
     332
     333
     334
     335
     336
     337
     338
<doc 339
     340
     341

     342
     343
     344
     345
     346
     347
     348
     349
     350
     351
     352
     353
<doc 354
     355
     356
     357

     358
     359
     360
     361
/*
 *   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_SYMMETRIC_IMPL_SYMATRIX_H
#define FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SYMATRIX_H 1

#include <cxxblas/typedefs.h>
#include <flens/auxiliary/auxiliary.h>
#include <flens/auxiliary/underscore.h>
#include <flens/matrixtypes/symmetric/symmetricmatrix.h>
#include <flens/typedefs.h>

namespace flens {

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

template <typename FS>
    class GeMatrix;

template <typename FS>
    class HeMatrix;

template <typename FS>
    class TrMatrix;

template <typename FS>
class SyMatrix
    : public SymmetricMatrix<SyMatrix<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 for
        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>           ConstHermitianView;
        typedef HeMatrix<EngineView>                HermitianView;
        typedef HeMatrix<EngineNoView>              HermitianNoView;

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

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

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

        SyMatrix(IndexType dim, StorageUpLo upLo);

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

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

        SyMatrix(const Engine &engine, StorageUpLo upLo);

        SyMatrix(const SyMatrix &rhs);

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

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

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

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

        SyMatrix &
        operator=(const SyMatrix &rhs);

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

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

        template <typename RHS>
            SyMatrix &
            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;

        StorageOrder
        order() const;

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

        template <typename RHS>
            bool
            resize(const SyMatrix<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();

        // hermitian views
        const ConstHermitianView
        hermitian() const;

        HermitianView
        hermitian();

        // 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 --------------------------------------------------------------------
//
//  IsSyMatrix
//
struct _SyMatrixChecker
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(_AnyConversion);

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

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

//
//  IsRealSyMatrix
//
template <typename T>
struct IsRealSyMatrix
{
    typedef typename std::remove_reference<T>::type  TT;

    static const bool value = IsSyMatrix<TT>::value
                           && IsNotComplex<typename TT::ElementType>::value;
};

//
//  IsComplexSyMatrix
//
template <typename T>
struct IsComplexSyMatrix
{
    typedef typename std::remove_reference<T>::type  TT;

    static const bool value = IsSyMatrix<TT>::value
                           && IsComplex<typename TT::ElementType>::value;
};

//-- SyMatrix specific functions -----------------------------------------------

//
//  fillRandom
//

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

// namespace flens

#endif // FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SYMATRIX_H