Template Struct PowerIterationAlgoTpl

Struct Documentation

template<typename _Vector>
struct PowerIterationAlgoTpl

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

Public Types

typedef Vector::Scalar Scalar

Public Functions

typedef PINOCCHIO_EIGEN_PLAIN_TYPE (_Vector) Vector
inline explicit PowerIterationAlgoTpl(const Eigen::DenseIndex size, const int max_it = 10, const Scalar rel_tol = Scalar(1e-8))
template<typename MatrixLike>
inline void run(const MatrixLike &mat)
template<typename MatrixLike, typename VectorLike>
inline void run(const MatrixLike &mat, const Eigen::PlainObjectBase<VectorLike> &eigenvector_est)
template<typename MatrixLike>
inline void lowest(const MatrixLike &mat, const bool compute_largest = true)
template<typename MatrixLike, typename VectorLike>
inline 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 void reset()

Public Members

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

Protected Attributes

Vector eigen_vector_prev