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
<doc  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
      91
      92
      93
<doc  94
      95

      96
<doc  97
      98
<doc  99
     100
<doc 101
     102

     103
<doc 104
     105

     106
<doc 107
     108

     109
     110
     111
<doc 112
     113

     114
<doc 115
     116
     117

     118
<doc 119
     120
     121

     122
<doc 123
     124
     125

     126
<doc 127
     128

     129
<doc 130
     131

     132
<doc 133
     134

     135
<doc 136
     137

     138
<doc 139
     140

     141
<doc 142
     143

     144
<doc 145
     146

     147
     148
<doc 149
     150

     151
<doc 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
<doc 176
     177

     178
<doc 179
     180

     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
     204
<doc 205
     206

     207
<doc 208
     209

     210
<doc 211
     212

     213
<doc 214
     215

     216
<doc 217
     218

     219
<doc 220
     221

     222
<doc 223
     224
     225
     226

     227
<doc 228
     229
     230
     231
     232

     233
<doc 234
     235

     236
<doc 237
     238

     239
     240
<doc 241
     242

     243
<doc 244
     245

     246
<doc 247
     248

     249
<doc 250
     251

     252
<doc 253
     254

     255
<doc 256
     257

     258
     259
     260
     261
     262
     263
     264
     265
     266
     267
     268
<doc 269
     270

     271
<doc 272
     273
     274
     275
     276
     277
     278
     279
     280
     281
     282
     283
     284
<doc 285
     286
     287

     288
     289
     290
     291
     292
     293
     294
<doc 295
     296
     297

     298
     299
     300
     301
     302
     303
     304
     305
     306
<doc 307
     308
     309

     310
     311
     312
     313
     314
     315
     316
     317
     318
     319
/*
 *   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_TBMATRIX_H
#define FLENS_MATRIXTYPES_TRIANGULAR_IMPL_TBMATRIX_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 FS>
    class GbMatrix;

template <typename FS>
    class HbMatrix;

template <typename FS>
    class SbMatrix;

template <typename FS>
class TbMatrix
    : public TriangularMatrix<TbMatrix<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 GbMatrix<EngineConstView>           ConstGeneralView;
        typedef GbMatrix<EngineView>                GeneralView;
        typedef GbMatrix<EngineNoView>              GeneralNoView;

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

        typedef SbMatrix<EngineConstView>           ConstSymmetricView;
        typedef SbMatrix<EngineView>                SymmetricView;
        typedef SbMatrix<EngineNoView>              SymmetricNoView;

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

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

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

        TbMatrix(const TbMatrix &rhs);

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

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

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

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

        TbMatrix &
        operator=(const TbMatrix &rhs);

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

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

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

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

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

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

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

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

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

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

        // general views
        const ConstGeneralView
        general() const;

        GeneralView
        general();

        // hermitian views
        const ConstHermitianView
        hermitian() const;

        HermitianView
        hermitian();

        // symmetric views
        const ConstSymmetricView
        symmetric() const;

        SymmetricView
        symmetric();

        // triangular view
        const ConstView
        triangular() const;

        View
        triangular();

        VectorView
        diag(IndexType diag);

        const ConstVectorView
        diag(IndexType diag) const;

        // -- views ------------------------------------------------------------


        // -- methods ----------------------------------------------------------
        IndexType
        dim() const;

        IndexType
        numCols() const;

        IndexType
        numRows() const;

        IndexType
        numOffDiags() const;

        IndexType
        numSubDiags() const;

        IndexType
        numSuperDiags() const;

        // for element access
        IndexType
        firstIndex() const;

        IndexType
        lastIndex() const;

        IndexType
        leadingDimension() const;

        StorageOrder
        order() const;

        const ElementType *
        data() const;

        ElementType *
        data();

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

        bool
        resize(IndexType dim,
               IndexType numOffDiags,
               IndexType firstColIndex = 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();

        Diag
        diag() const;

        Diag &
        diag();

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

//-- Traits --------------------------------------------------------------------
//
//  IsTbMatrix
//
struct TbMatrixChecker_
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(AnyConversion_);

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

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

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

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

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

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


// namespace flens

#endif // FLENS_MATRIXTYPES_TRIANGULAR_IMPL_TBMATRIX_H