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 DTREVC( SIDE, HOWMNY, SELECT, N, T, LDT, VL, LDVL, VR,
36       $                   LDVR, MM, M, WORK, INFO )
37  *
38  *  -- LAPACK routine (version 3.3.1) --
39  *  -- LAPACK is a software package provided by Univ. of Tennessee,    --
40  *  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
41  *  -- April 2011                                                      --
42  */
43 
44 #ifndef FLENS_LAPACK_EIG_TREVC_H
45 #define FLENS_LAPACK_EIG_TREVC_H 1
46 
47 #include <flens/matrixtypes/matrixtypes.h>
48 #include <flens/vectortypes/vectortypes.h>
49 
50 namespace flens { namespace lapack {
51 
52 namespace TREVC {
53 
54     enum Job {
55         All,             // 'A':  compute all right and/or left eigenvectors;
56         Backtransform,   // 'B':  compute all right and/or left eigenvectors,
57                          //       backtransformed by the matrices in VR
58                          //       and/or VL;
59         Selected         // 'S':  compute selected right and/or left
60                          //       eigenvectors, as indicated by the logical
61                          //       array SELECT.
62     };
63 
64 }
65 
66 //== trevc =====================================================================
67 template <typename VSELECT, typename MTR, typename MVL, typename MVR,
68           typename IndexType, typename VWORK>
69     void
70     trevc(bool                          computeVL,
71           bool                          computeVR,
72           TREVC::Job                    howMany,
73           DenseVector<VSELECT>          &select,
74           const GeMatrix<MTR>           &Tr,
75           GeMatrix<MVL>                 &VL,
76           GeMatrix<MVR>                 &VR,
77           IndexType                     mm,
78           IndexType                     &m,
79           DenseVector<VWORK>            &work);
80 
81 //-- forwarding ----------------------------------------------------------------
82 template <typename VSELECT, typename MTR, typename MVL, typename MVR,
83           typename IndexType, typename VWORK>
84     void
85     trevc(bool                          computeVL, 
86           bool                          computeVR,
87           TREVC::Job                    howMany,
88           const VSELECT                 &select,
89           const MTR                     &Tr,
90           MVL                           &&VL,
91           MVR                           &&VR,
92           IndexType                     mm,
93           IndexType                     &&m,
94           VWORK                         &&work);
95 
96 } } // namespace lapack, flens
97 
98 #endif // FLENS_LAPACK_EIG_TREVC_H