mvswitch.h (flens/blas/closures/level2/mvswitch.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
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
<doc 59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
<doc 70
     71
     72
     73
     74
     75
     76
     77
     78
<doc 79
     80
     81
     82
     83
     84
     85
     86
     87
     88
<doc 89
     90
     91
     92
     93
     94
     95
     96
     97
     98

/*
*   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_BLAS_CLOSURES_LEVEL2_MVSWITCH_H
#define FLENS_BLAS_CLOSURES_LEVEL2_MVSWITCH_H 1

#include <cxxblas/cxxblas.h>
#include <flens/blas/closures/tweaks/defaulteval.h>
#include <flens/blas/operators/operators.h>
#include <flens/matrixtypes/matrixtypes.h>
#include <flens/typedefs.h>
#include <flens/vectortypes/vectortypes.h>

namespace flens { namespace blas {

//
//  This switch evaluates closures of the form
//
//      y = beta*y + A*x
//
//  If x is a closure then it gets evaluated and a temporary gets created to
//  store the result.  For matrix A we distinguish between three cases:
//  case 1: A is no closure
//  case 2: A is a scaling closure (i.e. scale*A)
//  case 3: A is some other closure

//
//  Entry point for mvSwitch
//
template <typename ALPHA, typename MA, typename VX, typename BETA, typename VY>
    typename RestrictTo<IsSame<MA, typename MA::Impl>::value
                     && IsSame<VX, typename VX::Impl>::value
                     && IsSame<VY, typename VY::Impl>::value,
             void>::Type
    mvSwitch(Transpose trans, const ALPHA &alpha, const MA &A, const VX &x,
             const BETA &beta, VY &y);

//
//  case 1: A is no closure
//
template <typename ALPHA, typename MA, typename VX, typename BETA, typename VY>
    typename RestrictTo<!IsClosure<MA>::value,
             void>::Type
    mvCase(Transpose trans, const ALPHA &alpha, const MA &A, const VX &x,
           const BETA &beta, VY &y);

//
//  case 2: A is closure of type scale*A
//
template <typename ALPHA, typename T, typename MA, typename VX, typename BETA,
          typename VY>
    void
    mvCase(Transpose trans, const ALPHA &alpha,
           const MatrixClosure<OpMult, ScalarValue<T>, MA> &scale_A,
           const VX &x, const BETA &beta, VY &y);

//
//  case 3: A is some other closure
//
template <typename ALPHA, typename Op, typename L, typename R, typename VX,
          typename BETA, typename VY>
    void
    mvCase(Transpose trans, const ALPHA &alpha,
           const MatrixClosure<Op, L, R> &A,
           const VX &x, const BETA &beta, VY &y);

} } // namespace blas, flens

#endif // FLENS_BLAS_CLOSURES_LEVEL2_MVSWITCH_H