1 /*
  2  *   Copyright (c) 2011, 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 /* Based on
 34  *
 35        SUBROUTINE DLASCL( TYPE, KL, KU, CFROM, CTO, M, N, A, LDA, INFO )
 36  *
 37  *  -- LAPACK auxiliary routine (version 3.3.0) --
 38  *  -- LAPACK is a software package provided by Univ. of Tennessee,    --
 39  *  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
 40  *     November 2010
 41  */
 42 
 43 #ifndef FLENS_LAPACK_AUX_LASCL_H
 44 #define FLENS_LAPACK_AUX_LASCL_H 1
 45 
 46 
 47 #include <flens/aux/aux.h>
 48 #include <flens/matrixtypes/matrixtypes.h>
 49 #include <flens/vectortypes/vectortypes.h>
 50 
 51 namespace flens { namespace lapack {
 52 
 53 namespace LASCL {
 54 
 55     enum Type {
 56         FullMatrix,             // = 'G':  A is a full matrix.
 57         LowerTriangular,        // = 'L':  A is a lower triangular matrix.
 58         UpperTriangular,        // = 'U':  A is an upper triangular matrix.
 59         UpperHessenberg,        // = 'H':  A is an upper Hessenberg matrix.
 60         SymmetricLowerBand,     // = 'B':  A is a symmetric band matrix with
 61                                 //         lower bandwidth KL and upper
 62                                 //         bandwidth KU and with the only
 63                                 //         the lower half stored.
 64         SymmetricUpperBand,     // = 'Q':  A is a symmetric band matrix with
 65                                 //         lower bandwidth KL and upper
 66                                 //         bandwidth KU and with the only the
 67                                 //         upper half stored.
 68         GeneralBand             // = 'Z':  A is a band matrix with lower
 69                                 //         bandwidth KL and upper bandwidth KU.
 70     };
 71 
 72 // namespace LANGE
 73 
 74 // TODO: provide an interface for different matrix types, i.e. GeMatrix,
 75 //       TrMatrix, SbMatrix, HessenbergMatrix, vector types and scalars
 76 //-- lascl ---------------------------------------------------------------------
 77 template <typename IndexType, typename T, typename MA>
 78     typename RestrictTo<IsSame<typename MA::ElementType, T>::value, void>::Type
 79     lascl(LASCL::Type type, IndexType kl, IndexType ku,
 80           const T &cFrom, const T &cTo, MA &A);
 81 
 82 template <typename IndexType, typename T, typename MA>
 83     typename RestrictTo<IsSame<MA, T>::value, void>::Type
 84     lascl(LASCL::Type type, IndexType kl, IndexType ku,
 85           const T &cFrom, const T &cTo, MA &A);
 86 
 87 //-- forwarding ----------------------------------------------------------------
 88 template <typename IndexType, typename T, typename MA>
 89     typename RestrictTo<IsSame<typename MA::ElementType, T>::value, void>::Type
 90     lascl(LASCL::Type type, IndexType kl, IndexType ku,
 91           const T &cFrom, const T &cTo, MA &&A);
 92 
 93 template <typename IndexType, typename T, typename VX>
 94     void
 95     lascl(LASCL::Type type, IndexType kl, IndexType ku,
 96           const T &cFrom, const T &cTo, DenseVector<VX> &x);
 97 
 98 } } // namespace lapack, flens
 99 
100 #endif // FLENS_LAPACK_AUX_LASCL_H