Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / src / Householder / BlockHouseholder.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2010 Vincent Lejeune
5 // Copyright (C) 2010 Gael Guennebaud <gael.guennebaud@inria.fr>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_BLOCK_HOUSEHOLDER_H
27 #define EIGEN_BLOCK_HOUSEHOLDER_H
28
29 // This file contains some helper function to deal with block householder reflectors
30
31 namespace internal {
32
33 /** \internal */
34 template<typename TriangularFactorType,typename VectorsType,typename CoeffsType>
35 void make_block_householder_triangular_factor(TriangularFactorType& triFactor, const VectorsType& vectors, const CoeffsType& hCoeffs)
36 {
37   typedef typename TriangularFactorType::Index Index;
38   typedef typename VectorsType::Scalar Scalar;
39   const Index nbVecs = vectors.cols();
40   eigen_assert(triFactor.rows() == nbVecs && triFactor.cols() == nbVecs && vectors.rows()>=nbVecs);
41
42   for(Index i = 0; i < nbVecs; i++)
43   {
44     Index rs = vectors.rows() - i;
45     Scalar Vii = vectors(i,i);
46     vectors.const_cast_derived().coeffRef(i,i) = Scalar(1);
47     triFactor.col(i).head(i).noalias() = -hCoeffs(i) * vectors.block(i, 0, rs, i).adjoint()
48                                        * vectors.col(i).tail(rs);
49     vectors.const_cast_derived().coeffRef(i, i) = Vii;
50     // FIXME add .noalias() once the triangular product can work inplace
51     triFactor.col(i).head(i) = triFactor.block(0,0,i,i).template triangularView<Upper>()
52                              * triFactor.col(i).head(i);
53     triFactor(i,i) = hCoeffs(i);
54   }
55 }
56
57 /** \internal */
58 template<typename MatrixType,typename VectorsType,typename CoeffsType>
59 void apply_block_householder_on_the_left(MatrixType& mat, const VectorsType& vectors, const CoeffsType& hCoeffs)
60 {
61   typedef typename MatrixType::Index Index;
62   enum { TFactorSize = MatrixType::ColsAtCompileTime };
63   Index nbVecs = vectors.cols();
64   Matrix<typename MatrixType::Scalar, TFactorSize, TFactorSize> T(nbVecs,nbVecs);
65   make_block_householder_triangular_factor(T, vectors, hCoeffs);
66
67   const TriangularView<VectorsType, UnitLower>& V(vectors);
68
69   // A -= V T V^* A
70   Matrix<typename MatrixType::Scalar,VectorsType::ColsAtCompileTime,MatrixType::ColsAtCompileTime,0,
71          VectorsType::MaxColsAtCompileTime,MatrixType::MaxColsAtCompileTime> tmp = V.adjoint() * mat;
72   // FIXME add .noalias() once the triangular product can work inplace
73   tmp = T.template triangularView<Upper>().adjoint() * tmp;
74   mat.noalias() -= V * tmp;
75 }
76
77 } // end namespace internal
78
79 #endif // EIGEN_BLOCK_HOUSEHOLDER_H