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
<doc  52
      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
<doc  89
      90
<doc  91
      92
<doc  93
      94
<doc  95
      96

      97
<doc  98
      99

     100
<doc 101
     102

     103
     104
     105
<doc 106
     107

     108
<doc 109
     110

     111
<doc 112
     113
     114

     115
<doc 116
     117

     118
<doc 119
     120

     121
<doc 122
     123

     124
<doc 125
     126

     127
<doc 128
     129

     130
<doc 131
     132

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

     156
<doc 157
     158

     159
<doc 160
     161

     162
<doc 163
     164

     165
<doc 166
     167

     168
<doc 169
     170

     171
<doc 172
     173

     174
<doc 175
     176

     177
<doc 178
     179

     180
<doc 181
     182

     183
<doc 184
     185
     186
     187

     188
<doc 189
     190
     191
     192

     193
     194
     195
     196
<doc 197
     198

     199
<doc 200
     201

     202
     203
<doc 204
     205

     206
<doc 207
     208

     209
     210
<doc 211
     212

     213
<doc 214
     215

     216
     217
     218
<doc 219
     220

     221
<doc 222
     223

     224
     225
     226
     227
     228
     229
     230
     231
     232
     233
     234
<doc 235
     236

     237
<doc 238
     239
     240
     241
     242
     243
     244
     245
     246
     247
     248
     249
     250
<doc 251
     252
     253

     254
     255
     256
     257
     258
     259
     260
<doc 261
     262
     263

     264
     265
     266
     267
     268
     269
     270
     271
     272
<doc 273
     274
     275

     276
     277
     278
     279
     280
     281
     282
     283
     284
     285
/*
 *   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_TRIANGULAR_IMPL_TPMATRIX_H
#define FLENS_MATRIXTYPES_TRIANGULAR_IMPL_TPMATRIX_H 1

#include <flens/auxiliary/auxiliary.h>
#include <flens/matrixtypes/triangular/triangularmatrix.h>
#include <flens/typedefs.h>

namespace flens {

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

template <typename PS>
    class HpMatrix;

template <typename PS>
    class SpMatrix;

template <typename PS>
class TpMatrix
    : public TriangularMatrix<TpMatrix<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
        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>           ConstSymmetricView;
        typedef SpMatrix<EngineView>                SymmetricView;
        typedef SpMatrix<EngineNoView>              SymmetricNoView;

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

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

        TpMatrix(IndexType dim, StorageUpLo upLo, Diag diag = NonUnit);

        TpMatrix(const Engine &engine, StorageUpLo upLo, Diag diag = NonUnit);

        TpMatrix(const TpMatrix &rhs);

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

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

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

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

        TpMatrix &
        operator=(const ElementType &alpha);

        TpMatrix &
        operator=(const TpMatrix &rhs);

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

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

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

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

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

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

        TpMatrix &
        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();

        Diag
        diag() const;

        Diag &
        diag();

        const ElementType *
        data() const;

        ElementType *
        data();

        StorageOrder
        order() const;

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

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

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

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

        // hermitian views
        const ConstHermitianView
        hermitian() const;

        HermitianView
        hermitian();

        // symmetric views
        const ConstSymmetricView
        symmetric() const;

        SymmetricView
        symmetric();

        // triangular views
        const ConstView
        triangular() const;

        View
        triangular();

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

        const Engine &
        engine() const;

        Engine &
        engine();

    private:
        Engine       engine_;
        StorageUpLo  upLo_;
        Diag         diag_;
};

//-- Traits --------------------------------------------------------------------
//
//  IsTpMatrix
//
struct TpMatrixChecker_
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(AnyConversion_);

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

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

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

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

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

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


// namespace flens

#endif // FLENS_MATRIXTYPES_TRIANGULAR_IMPL_TPMATRIX_H