pulsatrix::DominantEigenResult Struct Reference

PowerIteration()'s result. More...

#include <matrix_decompositions.hpp>

Collaboration diagram for pulsatrix::DominantEigenResult:

Public Attributes
float	value
	The dominant eigenvalue (largest in magnitude), as a Rayleigh quotient.
Tensor	vector
	Shape (n): its unit eigenvector, sign made canonical.
int64_t	iterations
	Iterations run. Equals max_iterations when not converged.
bool	converged
	Whether successive vectors agreed to within the tolerance.

Detailed Description

PowerIteration()'s result.

Member Data Documentation

converged

bool pulsatrix::DominantEigenResult::converged

Whether successive vectors agreed to within the tolerance.

iterations

int64_t pulsatrix::DominantEigenResult::iterations

Iterations run. Equals max_iterations when not converged.

value

float pulsatrix::DominantEigenResult::value

The dominant eigenvalue (largest in magnitude), as a Rayleigh quotient.

vector

Tensor pulsatrix::DominantEigenResult::vector

Shape (n): its unit eigenvector, sign made canonical.

---

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

• include/pulsatrix/matrix_decompositions.hpp