pulsatrix 1.1.0
Loading...
Searching...
No Matches
matrix_decompositions.hpp
Go to the documentation of this file.
1
14#pragma once
15
16#include <cstdint>
17#include <vector>
18
19#include "pulsatrix/tensor.hpp"
20
21namespace pulsatrix {
22
30
42
44struct QRResult {
49};
50
60
72[[nodiscard]] EigenResult SymmetricEigen(const Tensor& a);
73
83[[nodiscard]] std::vector<double> SymmetricEigenvalues(std::vector<double> a, int64_t n);
84
88 std::vector<double> values;
91 std::vector<double> vectors;
92};
93
100[[nodiscard]] DoubleEigenResult SymmetricEigenInDouble(std::vector<double> a, int64_t n);
101
115[[nodiscard]] DominantEigenResult PowerIteration(const Tensor& a, int64_t max_iterations = 1000,
116 float tolerance = 1e-6f, uint64_t seed = 0);
117
124[[nodiscard]] QRResult QR(const Tensor& a);
125
135[[nodiscard]] SVDResult SVD(const Tensor& a);
136
137} // namespace pulsatrix
N-dimensional tensor. Owns its data buffer exclusively; a DeviceBackend* is injected (not owned) – th...
Definition tensor.hpp:29
Definition acquisition_functions.hpp:16
QRResult QR(const Tensor &a)
Thin QR factorization by Householder reflections.
EigenResult SymmetricEigen(const Tensor &a)
All eigenvalues and eigenvectors of a symmetric matrix, by Householder reduction to tridiagonal form ...
DoubleEigenResult SymmetricEigenInDouble(std::vector< double > a, int64_t n)
SymmetricEigen() in double precision from end to end, eigenvectors included: PCA's directions and var...
std::vector< double > SymmetricEigenvalues(std::vector< double > a, int64_t n)
SymmetricEigen()'s eigenvalues, in double precision from end to end: for a matrix computed in double,...
SVDResult SVD(const Tensor &a)
Thin singular value decomposition by one-sided (Hestenes) Jacobi rotations.
DominantEigenResult PowerIteration(const Tensor &a, int64_t max_iterations=1000, float tolerance=1e-6f, uint64_t seed=0)
The dominant eigenpair of a symmetric matrix by power iteration – cheaper than SymmetricEigen() when ...
PowerIteration()'s result.
Definition matrix_decompositions.hpp:32
float value
The dominant eigenvalue (largest in magnitude), as a Rayleigh quotient.
Definition matrix_decompositions.hpp:34
int64_t iterations
Iterations run. Equals max_iterations when not converged.
Definition matrix_decompositions.hpp:38
bool converged
Whether successive vectors agreed to within the tolerance.
Definition matrix_decompositions.hpp:40
Tensor vector
Shape (n): its unit eigenvector, sign made canonical.
Definition matrix_decompositions.hpp:36
SymmetricEigenInDouble()'s result.
Definition matrix_decompositions.hpp:86
std::vector< double > vectors
Row-major (n, n): row j is the unit eigenvector for values[j], sign made canonical as SymmetricEigen(...
Definition matrix_decompositions.hpp:91
std::vector< double > values
The n eigenvalues, largest first.
Definition matrix_decompositions.hpp:88
SymmetricEigen()'s result.
Definition matrix_decompositions.hpp:24
Tensor values
Shape (n): eigenvalues, largest first.
Definition matrix_decompositions.hpp:26
Tensor vectors
Shape (n, n): column j is the unit eigenvector for values[j].
Definition matrix_decompositions.hpp:28
QR()'s result, the thin factorization A = Q R.
Definition matrix_decompositions.hpp:44
Tensor q
Shape (m, n): orthonormal columns.
Definition matrix_decompositions.hpp:46
Tensor r
Shape (n, n): upper triangular, non-negative diagonal.
Definition matrix_decompositions.hpp:48
SVD()'s result, the thin factorization A = U diag(S) V^T with k = min(m, n).
Definition matrix_decompositions.hpp:52
Tensor s
Shape (k): singular values, largest first, non-negative.
Definition matrix_decompositions.hpp:56
Tensor v
Shape (n, k): orthonormal right singular vectors, signs made canonical.
Definition matrix_decompositions.hpp:58
Tensor u
Shape (m, k): orthonormal left singular vectors.
Definition matrix_decompositions.hpp:54
N-dimensional tensor – owns a buffer via DeviceBackend*, RAII (Rule of Five).