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
<doc 103
     104
<doc 105
     106
<doc 107
     108

     109
<doc 110
     111

     112
<doc 113
     114

     115
     116
     117
<doc 118
     119

     120
<doc 121
     122
     123

     124
<doc 125
     126
     127

     128
<doc 129
     130
     131

     132
<doc 133
     134

     135
<doc 136
     137

     138
<doc 139
     140

     141
<doc 142
     143

     144
<doc 145
     146

     147
<doc 148
     149

     150
<doc 151
     152

     153
     154
     155
     156
<doc 157
     158

     159
<doc 160
     161

     162
     163
<doc 164
     165

     166
<doc 167
     168

     169
     170
<doc 171
     172

     173
<doc 174
     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
<doc 243
     244

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

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

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

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

     296
     297
     298
     299
     300
     301
     302
     303
     304
     305
/*
 *   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 <cxxblas/typedefs.h>
#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
        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
        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