trevc.h (flens/lapack/impl/trevc.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
     59
     60
     61
     62
     63
     64
     65
     66
     67
<doc 68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99

/*
*   Copyright (c) 2011, 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.
*/

/* Based on
*
       SUBROUTINE DTREVC( SIDE, HOWMNY, SELECT, N, T, LDT, VL, LDVL, VR,
      $                   LDVR, MM, M, WORK, INFO )
*
*  -- LAPACK routine (version 3.3.1) --
*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
*  -- April 2011                                                      --
*/

#ifndef FLENS_LAPACK_IMPL_TREVC_H
#define FLENS_LAPACK_IMPL_TREVC_H 1

#include <flens/lapack/typedefs.h>
#include <flens/matrixtypes/matrixtypes.h>
#include <flens/vectortypes/vectortypes.h>

namespace flens { namespace lapack {

namespace TREVC {

    enum Job {
        All = 'A',             // compute all right and/or left eigenvectors;
        Backtransform = 'B',   // compute all right and/or left eigenvectors,
                               // backtransformed by the matrices in VR
                               // and/or VL;
        Selected = 'S'         // compute selected right and/or left
                               // eigenvectors, as indicated by the logical
                               // array SELECT.
    };

}

//== trevc =====================================================================
template <typename VSELECT, typename MTR, typename MVL, typename MVR,
          typename IndexType, typename VWORK>
    void
    trevc(bool                          computeVL,
          bool                          computeVR,
          TREVC::Job                    howMany,
          DenseVector<VSELECT>          &select,
          const GeMatrix<MTR>           &Tr,
          GeMatrix<MVL>                 &VL,
          GeMatrix<MVR>                 &VR,
          IndexType                     mm,
          IndexType                     &m,
          DenseVector<VWORK>            &work);

//-- forwarding ----------------------------------------------------------------
template <typename VSELECT, typename MTR, typename MVL, typename MVR,
          typename IndexType, typename VWORK>
    void
    trevc(bool                          computeVL,
          bool                          computeVR,
          TREVC::Job                    howMany,
          const VSELECT                 &select,
          const MTR                     &Tr,
          MVL                           &&VL,
          MVR                           &&VR,
          IndexType                     mm,
          IndexType                     &&m,
          VWORK                         &&work);

} } // namespace lapack, flens

#endif // FLENS_LAPACK_IMPL_TREVC_H