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
<doc  53
      54
      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
<doc  91
      92
<doc  93
      94
<doc  95
      96
<doc  97
      98

      99
<doc 100
     101

     102
<doc 103
     104

     105
     106
     107
<doc 108
     109

     110
<doc 111
     112

     113
<doc 114
     115
     116

     117
<doc 118
     119
     120

     121
<doc 122
     123
     124

     125
<doc 126
     127

     128
<doc 129
     130

     131
<doc 132
     133

     134
<doc 135
     136

     137
<doc 138
     139

     140
<doc 141
     142

     143
     144
     145
<doc 146
     147

     148
<doc 149
     150

     151
<doc 152
     153

     154
<doc 155
     156

     157
<doc 158
     159

     160
<doc 161
     162

     163
<doc 164
     165

     166
<doc 167
     168

     169
<doc 170
     171

     172
<doc 173
     174

     175
<doc 176
     177

     178
<doc 179
     180

     181
<doc 182
     183

     184
<doc 185
     186

     187
<doc 188
     189
     190
     191

     192
<doc 193
     194
     195
     196

     197
     198
     199
     200
<doc 201
     202

     203
<doc 204
     205

     206
     207
<doc 208
     209

     210
<doc 211
     212

     213
     214
<doc 215
     216

     217
<doc 218
     219

     220
     221
     222
<doc 223
     224

     225
<doc 226
     227

     228
     229
     230
     231
     232
     233
     234
     235
     236
     237
<doc 238
     239

     240
<doc 241
     242
     243
     244
     245
     246
     247
     248
     249
     250
     251
     252
     253
<doc 254
     255
     256

     257
     258
     259
     260
     261
     262
     263
<doc 264
     265
     266

     267
     268
     269
     270
     271
     272
     273
     274
     275
<doc 276
     277
     278

     279
     280
     281
     282
     283
     284
     285
     286
     287
     288
/*
 *   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_SPMATRIX_H
#define FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SPMATRIX_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 PS>
    class HpMatrix;

template <typename PS>
    class TpMatrix;

template <typename PS>
class SpMatrix
    : public SymmetricMatrix<SpMatrix<PS> >
{
    public:
        typedef PS                                  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
        // view types for
        typedef DenseVector<ConstArrayView>         ConstVectorView;
        typedef DenseVector<ArrayView>              VectorView;
        typedef DenseVector<Array>                  Vector;

        typedef HpMatrix<EngineConstView>           ConstHermitianView;
        typedef HpMatrix<EngineView>                HermitianView;
        typedef HpMatrix<EngineNoView>              HermitianNoView;

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

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

        //-- Constructors ------------------------------------------------------

        SpMatrix(IndexType dim, StorageUpLo upLo = Upper);

        SpMatrix(const Engine &engine, StorageUpLo upLo);

        SpMatrix(const SpMatrix &rhs);

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

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

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

        //-- Operators ---------------------------------------------------------

        void
        operator=(const ElementType &alpha);

        SpMatrix &
        operator=(const SpMatrix &rhs);

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

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

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

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

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

        SpMatrix &
        operator+=(const ElementType &alpha);

        SpMatrix &
        operator-=(const ElementType &alpha);

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

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

        //-- Methods -----------------------------------------------------------

        IndexType
        numRows() const;

        IndexType
        numCols() const;

        IndexType
        dim() const;

        IndexType
        firstRow() const;

        IndexType
        lastRow() const;

        IndexType
        firstCol() const;

        IndexType
        lastCol() const;

        IndexType
        indexBase() const;

        StorageUpLo
        upLo() const;

        StorageUpLo &
        upLo();

        const ElementType *
        data() const;

        ElementType *
        data();

        StorageOrder
        order() const;

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

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

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

        //-- Views -------------------------------------------------------------

        // hermitian views
        const ConstHermitianView
        hermitian() const;

        HermitianView
        hermitian();

        // symmetric views
        const ConstView
        symmetric() const;

        View
        symmetric();

        // triangular views
        const ConstTriangularView
        triangular() const;

        TriangularView
        triangular();

        //-- Implementation ----------------------------------------------------

        const Engine &
        engine() const;

        Engine &
        engine();

    private:
        Engine      _engine;
        StorageUpLo _upLo;
};

//-- Traits --------------------------------------------------------------------
//
//  IsSpMatrix
//
struct _SpMatrixChecker
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(_AnyConversion);

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

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

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

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

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

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


// namespace flens

#endif // FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SPMATRIX_H