sycrsmatrix.h (flens/matrixtypes/symmetric/impl/sycrsmatrix.h)

       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
<doc 42
      43
      44
      45
      46
      47
      48
      49
      50
      51
<doc 52
      53
<doc 54
      55
      56
      57
<doc 58
      59
      60
      61
      62
<doc 63
      64
      65
<doc 66
      67
      68
<doc 69
      70
      71
<doc 72
      73
      74
<doc 75
      76
      77
<doc 78
      79
      80
<doc 81
      82
      83
<doc 84
      85
      86
<doc 87
      88
      89
<doc 90
      91
      92
      93
<doc 94
      95
      96
<doc 97
      98
      99
     100
     101
     102
     103
     104
     105
     106
     107
     108
     109
     110
     111
     112
     113
<doc 114
     115
     116
<doc 117
     118
     119
     120
     121
     122
     123
     124
     125
     126
     127
     128
     129
<doc 130
     131
     132
     133
     134
     135
     136
     137
     138
     139
<doc 140
     141
     142
     143
     144
     145
     146
     147
     148
     149
     150
     151
<doc 152
     153
     154
     155
     156
     157
     158
     159
     160
     161
     162
     163

/*
*   Copyright (c) 2012, Michael Lehn
*
*   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_SYCRSMATRIX_H
#define FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SYCRSMATRIX_H 1

#include <flens/auxiliary/auxiliary.h>
#include <flens/matrixtypes/symmetric/symmetricmatrix.h>
#include <flens/typedefs.h>

namespace flens {

template <typename CRS>
class SyCRSMatrix
    : public SymmetricMatrix<SyCRSMatrix<CRS> >
{
    public:
        typedef CRS                             Engine;
        typedef typename Engine::ElementType    ElementType;
        typedef typename Engine::IndexType      IndexType;

        // -- constructors -----------------------------------------------------
        SyCRSMatrix();

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

        // -- operators --------------------------------------------------------
        template <typename RHS>
            void
            operator=(const Matrix<RHS> &rhs);

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

        IndexType
        numRows() const;

        IndexType
        numCols() const;

        IndexType
        indexBase() const;

        IndexType
        firstRow() const;

        IndexType
        lastRow() const;

        IndexType
        firstCol() const;

        IndexType
        lastCol() const;

        StorageUpLo
        upLo() const;

        StorageUpLo &
        upLo();

        // -- implementation ---------------------------------------------------
        const Engine &
        engine() const;

        Engine &
        engine();

        // forbidden: This constructor never should get called.  Hence we
        //            don't define an implementation.
        SyCRSMatrix(const SyCRSMatrix &rhs);

    private:

        Engine       _engine;
        StorageUpLo  _upLo;
};

//-- Traits --------------------------------------------------------------------
//
//  IsSyCRSMatrix
//
struct _SyCRSMatrixChecker
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(_AnyConversion);

    template <typename Any>
        static char
        check(const SyCRSMatrix<Any> &);
};

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

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

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

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

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

} // namespace flens

#endif // FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SYCRSMATRIX_H