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

/*
*   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_SYCOORDMATRIX_H
#define FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SYCOORDMATRIX_H 1

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

namespace flens {

template <typename CS>
class SyCoordMatrix
    : public SymmetricMatrix<SyCoordMatrix<CS> >
{
    public:
        typedef CS                              Engine;
        typedef typename Engine::ElementType    ElementType;
        typedef typename Engine::IndexType      IndexType;
        typedef typename Engine::ElementProxy   ElementProxy;

        // -- constructors -----------------------------------------------------
        explicit
        SyCoordMatrix(IndexType   dim,
                      StorageUpLo upLo = Upper,
                      IndexType   densityEstimate = 1,
                      IndexType   indexBase = CS::defaultIndexBase);

        // -- operators --------------------------------------------------------
        ElementProxy
        operator()(IndexType row, IndexType col);

        // -- 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;

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

    private:
        // forbidden:
        SyCoordMatrix(const SyCoordMatrix &rhs);

        Engine       _engine;
        StorageUpLo  _upLo;
};

//-- Traits --------------------------------------------------------------------
//
//  IsSyCoordMatrix
//
struct _SyCoordMatrixChecker
{

    struct Two {
        char x;
        char y;
    };

    static Two
    check(_AnyConversion);

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

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

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

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

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

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

} // namespace flens

#endif // FLENS_MATRIXTYPES_SYMMETRIC_IMPL_SYCOORDMATRIX_H