pinocchio  3.7.0
A fast and flexible implementation of Rigid Body Dynamics algorithms and their analytical derivatives
 
Loading...
Searching...
No Matches
PowerIterationAlgoTpl< _Vector > Struct Template Reference

Compute the largest eigenvalues and the associated principle eigenvector via power iteration. More...

#include <pinocchio/math/eigenvalues.hpp>

Public Types

typedef Vector::Scalar Scalar
 
typedef _Vector Vector
 

Public Member Functions

 PowerIterationAlgoTpl (const Eigen::DenseIndex size, const int max_it=10, const Scalar rel_tol=Scalar(1e-8))
 
template<typename MatrixLike >
void lowest (const MatrixLike &mat, const bool compute_largest=true)
 
template<typename MatrixLike , typename VectorLike >
void lowest (const MatrixLike &mat, const Eigen::PlainObjectBase< VectorLike > &largest_eigenvector_est, const Eigen::PlainObjectBase< VectorLike > &lowest_eigenvector_est, const bool compute_largest=true)
 
void reset ()
 
template<typename MatrixLike >
void run (const MatrixLike &mat)
 
template<typename MatrixLike , typename VectorLike >
void run (const MatrixLike &mat, const Eigen::PlainObjectBase< VectorLike > &eigenvector_est)
 

Public Attributes

Scalar convergence_criteria
 
int it
 
Scalar largest_eigen_value
 
Scalar lowest_eigen_value
 
Vector lowest_eigen_vector
 
int max_it
 
Vector principal_eigen_vector
 
Scalar rel_tol
 

Protected Attributes

Vector eigen_vector_prev
 

Detailed Description

template<typename _Vector>
struct pinocchio::PowerIterationAlgoTpl< _Vector >

Compute the largest eigenvalues and the associated principle eigenvector via power iteration.

Definition at line 17 of file eigenvalues.hpp.

Member Typedef Documentation

◆ Scalar

Definition at line 20 of file eigenvalues.hpp.

◆ Vector

template<typename _Vector >
typedef _Vector Vector

Definition at line 19 of file eigenvalues.hpp.

Constructor & Destructor Documentation

◆ PowerIterationAlgoTpl()

template<typename _Vector >
PowerIterationAlgoTpl ( const Eigen::DenseIndex  size,
const int  max_it = 10,
const Scalar  rel_tol = Scalar(1e-8) 
)
inlineexplicit

Definition at line 22 of file eigenvalues.hpp.

Member Function Documentation

◆ lowest() [1/2]

template<typename _Vector >
template<typename MatrixLike >
void lowest ( const MatrixLike mat,
const bool  compute_largest = true 
)
inline

Definition at line 68 of file eigenvalues.hpp.

◆ lowest() [2/2]

template<typename _Vector >
void lowest ( const MatrixLike mat,
const Eigen::PlainObjectBase< VectorLike > &  largest_eigenvector_est,
const Eigen::PlainObjectBase< VectorLike > &  lowest_eigenvector_est,
const bool  compute_largest = true 
)
inline

Definition at line 99 of file eigenvalues.hpp.

◆ reset()

template<typename _Vector >
void reset ( )
inline

Definition at line 110 of file eigenvalues.hpp.

◆ run() [1/2]

template<typename _Vector >
template<typename MatrixLike >
void run ( const MatrixLike mat)
inline

Definition at line 35 of file eigenvalues.hpp.

◆ run() [2/2]

template<typename _Vector >
void run ( const MatrixLike mat,
const Eigen::PlainObjectBase< VectorLike > &  eigenvector_est 
)
inline

Definition at line 61 of file eigenvalues.hpp.

Member Data Documentation

◆ convergence_criteria

template<typename _Vector >
Scalar convergence_criteria

Definition at line 127 of file eigenvalues.hpp.

◆ eigen_vector_prev

template<typename _Vector >
Vector eigen_vector_prev
protected

Definition at line 130 of file eigenvalues.hpp.

◆ it

template<typename _Vector >
int it

Definition at line 125 of file eigenvalues.hpp.

◆ largest_eigen_value

template<typename _Vector >
Scalar largest_eigen_value

Definition at line 122 of file eigenvalues.hpp.

◆ lowest_eigen_value

template<typename _Vector >
Scalar lowest_eigen_value

Definition at line 123 of file eigenvalues.hpp.

◆ lowest_eigen_vector

template<typename _Vector >
Vector lowest_eigen_vector

Definition at line 121 of file eigenvalues.hpp.

◆ max_it

template<typename _Vector >
int max_it

Definition at line 124 of file eigenvalues.hpp.

◆ principal_eigen_vector

template<typename _Vector >
Vector principal_eigen_vector

Definition at line 120 of file eigenvalues.hpp.

◆ rel_tol

template<typename _Vector >
Scalar rel_tol

Definition at line 126 of file eigenvalues.hpp.


The documentation for this struct was generated from the following file: