Jacobi module

Classes
class	Eigen::JacobiRotation< Scalar >
	Rotation given by a cosine-sine pair. More...

Functions
template<typename OtherScalar >
void	Eigen::MatrixBase< Derived >::applyOnTheRight (Index p, Index q, const JacobiRotation< OtherScalar > &j)

Detailed Description

This module provides Jacobi and Givens rotations.

#include <Eigen/Jacobi>

In addition to listed classes, it defines the two following MatrixBase methods to apply a Jacobi or Givens rotation:

• MatrixBase::applyOnTheLeft()
• MatrixBase::applyOnTheRight().

Function Documentation

applyOnTheRight()

template<typename Derived >

template<typename OtherScalar >

void Eigen::MatrixBase< Derived >::applyOnTheRight ( Index  p, Index  q, const JacobiRotation< OtherScalar > &  j  )

inline

Applies the rotation in the plane j to the columns p and q of *this, i.e., it computes B = B * J with \( B = \left ( \begin{array}{cc} \text{*this.col}(p) & \text{*this.col}(q) \end{array} \right ) \).

See also

class JacobiRotation, MatrixBase::applyOnTheLeft(), internal::apply_rotation_in_the_plane()

Definition at line 313 of file Jacobi.h.

{
  ColXpr x(this->col(p));
  ColXpr y(this->col(q));
  internal::apply_rotation_in_the_plane(x, y, j.transpose());
}