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
<doc  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

     101
<doc 102
     103
<doc 104
     105
<doc 106
     107

     108
<doc 109
     110

     111
<doc 112
     113

     114
     115
     116
<doc 117
     118

     119
<doc 120
     121
     122

     123
<doc 124
     125
     126

     127
<doc 128
     129
     130

     131
<doc 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
     153
     154
     155
<doc 156
     157

     158
<doc 159
     160

     161
     162
<doc 163
     164

     165
<doc 166
     167

     168
     169
<doc 170
     171

     172
<doc 173
     174

     175
     176
<doc 177
     178

     179
<doc 180
     181

     182
     183
     184
<doc 185
     186

     187
<doc 188
     189

     190
<doc 191
     192

     193
<doc 194
     195

     196
<doc 197
     198

     199
<doc 200
     201

     202
<doc 203
     204

     205
<doc 206
     207

     208
<doc 209
     210

     211
<doc 212
     213

     214
<doc 215
     216
     217
     218

     219
<doc 220
     221
     222
     223

     224
<doc 225
     226

     227
<doc 228
     229

     230
     231
     232
<doc 233
     234

     235
<doc 236
     237

     238
<doc 239
     240

     241
<doc 242
     243

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

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

     273
     274
     275
     276
     277
     278
     279
<doc 280
     281
     282

     283
     284
     285
     286
     287
     288
     289
     290
     291
<doc 292
     293
     294

     295
     296
     297
     298
     299
     300
     301
     302
     303
     304
/*
 *   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_SYMMETRIC_IMPL_SBMATRIX_H
#define FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SBMATRIX_H 1

#include <flens/auxiliary/auxiliary.h>
#include <flens/matrixtypes/symmetric/symmetricmatrix.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 SbMatrix
    : public SymmetricMatrix<SbMatrix<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 HbMatrix<EngineConstView>           ConstHermitianView;
        typedef HbMatrix<EngineView>                HermitianView;
        typedef HbMatrix<EngineNoView>              HermitianNoView;

        typedef GbMatrix<EngineConstView>           ConstGeneralView;
        typedef GbMatrix<EngineView>                GeneralView;
        typedef GbMatrix<EngineNoView>              GeneralNoView;

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

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

        SbMatrix(StorageUpLo upLo = Upper);

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

        SbMatrix(const Engine &engine, StorageUpLo upLo);

        SbMatrix(const SbMatrix &rhs);

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

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

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

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

        SbMatrix &
        operator=(const SbMatrix &rhs);

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

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

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

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

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

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

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

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

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

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

        // -- 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
        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
        numOffDiags() const;

        IndexType
        leadingDimension() const;

        StorageOrder
        order() const;

        const ElementType *
        data() const;

        ElementType *
        data();

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

        StorageUpLo &
        upLo();

    private:
        Engine       engine_;
        StorageUpLo  upLo_;
};

//-- Traits --------------------------------------------------------------------
//
//  IsSbMatrix
//
struct SbMatrixChecker_
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(AnyConversion_);

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

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

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

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

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

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


// namespace flens

#endif // FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SBMATRIX_H