diff --git a/Eigen/src/Jacobi/Jacobi.h b/Eigen/src/Jacobi/Jacobi.h index b5940c74b..28b6cc7ad 100644 --- a/Eigen/src/Jacobi/Jacobi.h +++ b/Eigen/src/Jacobi/Jacobi.h @@ -26,9 +26,20 @@ #ifndef EIGEN_JACOBI_H #define EIGEN_JACOBI_H +/** Applies the counter clock wise 2D rotation of angle \c theta given by its + * cosine \a c and sine \a s to the set of 2D vectors of cordinates \a x and \a y: + * \f$ x = c x - s' y \f$ + * \f$ y = s x + c y \f$ + * + * \sa MatrixBase::applyJacobiOnTheLeft(), MatrixBase::applyJacobiOnTheRight() + */ template void ei_apply_rotation_in_the_plane(VectorX& _x, VectorY& _y, typename VectorX::Scalar c, typename VectorY::Scalar s); +/** Applies a rotation in the plane defined by \a c, \a s to the rows \a p and \a q of \c *this. + * More precisely, it computes B = J' * B, with J = [c s ; -s' c] and B = [ *this.row(p) ; *this.row(q) ] + * \sa MatrixBase::applyJacobiOnTheRight(), ei_apply_rotation_in_the_plane() + */ template inline void MatrixBase::applyJacobiOnTheLeft(int p, int q, Scalar c, Scalar s) { @@ -37,6 +48,10 @@ inline void MatrixBase::applyJacobiOnTheLeft(int p, int q, Scalar c, Sc ei_apply_rotation_in_the_plane(x, y, c, s); } +/** Applies a rotation in the plane defined by \a c, \a s to the columns \a p and \a q of \c *this. + * More precisely, it computes B = B * J, with J = [c s ; -s' c] and B = [ *this.col(p) ; *this.col(q) ] + * \sa MatrixBase::applyJacobiOnTheLeft(), ei_apply_rotation_in_the_plane() + */ template inline void MatrixBase::applyJacobiOnTheRight(int p, int q, Scalar c, Scalar s) { @@ -45,6 +60,12 @@ inline void MatrixBase::applyJacobiOnTheRight(int p, int q, Scalar c, S ei_apply_rotation_in_the_plane(x, y, c, s); } +/** Computes the cosine-sine pair (\a c, \a s) such that its associated + * rotation \f$ J = ( \begin{array}{cc} c & s \\ -s' c \end{array} )\f$ + * applied to both the right and left of the 2x2 matrix + * \f$ B = ( \begin{array}{cc} x & y \\ _ & z \end{array} )\f$ yields + * a diagonal matrix A: \f$ A = J' B J \f$ + */ template bool ei_makeJacobi(Scalar x, Scalar y, Scalar z, Scalar *c, Scalar *s) { @@ -128,12 +149,13 @@ void /*EIGEN_DONT_INLINE*/ ei_apply_rotation_in_the_plane(VectorX& _x, VectorY& const Packet pc = ei_pset1(c); const Packet ps = ei_pset1(s); + ei_conj_helper cj; for(int i=0; i