Michael Ernst Peter / Eigen

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

Jacobi module
Data Structures | Functions

Jacobi module

This module provides Jacobi and Givens rotations. More...

Data Structures

class  JacobiRotation< Scalar >
  More...

Functions

template<typename OtherScalar >
void applyOnTheRight (Index p, Index q, const JacobiRotation< OtherScalar > &j)
 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 ) $.

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

void applyOnTheRight ( Index  p,
Index  q,
const JacobiRotation< OtherScalar > &  j 
) [inherited]

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 292 of file src/Jacobi/Jacobi.h.

Generated on Thu Nov 17 2022 22:01:31 by  doxygen 1.7.2