1 /*
  2  *   Copyright (c) 2012, Michael Lehn
  3  *
  4  *   All rights reserved.
  5  *
  6  *   Redistribution and use in source and binary forms, with or without
  7  *   modification, are permitted provided that the following conditions
  8  *   are met:
  9  *
 10  *   1) Redistributions of source code must retain the above copyright
 11  *      notice, this list of conditions and the following disclaimer.
 12  *   2) Redistributions in binary form must reproduce the above copyright
 13  *      notice, this list of conditions and the following disclaimer in
 14  *      the documentation and/or other materials provided with the
 15  *      distribution.
 16  *   3) Neither the name of the FLENS development group nor the names of
 17  *      its contributors may be used to endorse or promote products derived
 18  *      from this software without specific prior written permission.
 19  *
 20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 31  */
 32 
 33 #ifndef FLENS_BLAS_CLOSURES_CLOSURETYPE_H
 34 #define FLENS_BLAS_CLOSURES_CLOSURETYPE_H 1
 35 
 36 #include <flens/aux/aux.h>
 37 #include <flens/blas/closures/prune.h>
 38 #include <flens/blas/operators/operators.h>
 39 
 40 namespace flens { namespace blas {
 41 
 42 template <typename Op, typename L, typename R>
 43 struct ClosureType
 44 {
 45     static const bool isMatrixVectorProduct = false;
 46     static const bool isResidual            = false;
 47     static const bool isMatrixMatrixProduct = false;
 48 };
 49 
 50 //
 51 //  A*x (matrix-vector product)
 52 //  x*A (vector-matrix product)
 53 //  A*B (matrix-matrix product)
 54 //
 55 template <typename L, typename R>
 56 struct ClosureType<OpMult, L, R>
 57 {
 58     static const bool isMatrixVectorProduct = IsMatrix<L>::value
 59                                            && IsVector<R>::value;
 60 
 61     static const bool isVectorMatrixProduct = IsVector<L>::value
 62                                            && IsMatrix<R>::value;
 63 
 64     static const bool isMatrixMatrixProduct = IsMatrix<L>::value
 65                                            && IsMatrix<R>::value;
 66 };
 67 
 68 //
 69 //  y + A*x  or  beta*y + A*x  (matrix-vector product)
 70 //
 71 template <typename VY, typename MA, typename VX>
 72 struct ClosureType<OpAdd, VY, VectorClosure<OpMult, MA, VX> >
 73 {
 74     // remove scaling
 75     typedef typename PruneScaling<VY>::Remainder   RVY;
 76 
 77     static const bool vectorY  = IsVector<VY>::value
 78                              && !IsClosure<RVY>::value;
 79 
 80     static const bool isMatrixVectorProduct = vectorY
 81                                            && IsMatrix<MA>::value
 82                                            && IsVector<VX>::value;
 83 };
 84 
 85 //
 86 //  C + A*B  or  beta*C + A*B  (matrix-matrix product)
 87 //
 88 template <typename MC, typename MA, typename MB>
 89 struct ClosureType<OpAdd, MC, MatrixClosure<OpMult, MA, MB> >
 90 {
 91     // remove scaling
 92     typedef typename PruneScaling<MC>::Remainder   RMC;
 93 
 94     static const bool matrixC  = IsMatrix<MC>::value
 95                              && !IsClosure<RMC>::value;
 96 
 97     static const bool isMatrixMatrixProduct = matrixC
 98                                            && IsMatrix<MA>::value
 99                                            && IsMatrix<MB>::value;
100 };
101 
102 //
103 //  b - A*x
104 //
105 template <typename VB, typename MA, typename VX>
106 struct ClosureType<OpSub, VB, VectorClosure<OpMult, MA, VX> >
107 {
108     static const bool isMatrixVectorProduct = IsVector<VB>::value
109                                            && IsMatrix<MA>::value
110                                            && IsVector<VX>::value;
111 
112     static const bool isResidual = isMatrixVectorProduct
113                                 && !IsClosure<VB>::value
114                                 && !IsClosure<MA>::value
115                                 && !IsClosure<VX>::value;
116 };
117 
118 
119 } } // namespace blas, flens
120 
121 #endif // FLENS_BLAS_CLOSURES_CLOSURETYPE_H