uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo > Struct Template Reference

Owning factors and statistics returned by truncated_svd. More...

#include <truncated_svd.hpp>

Public Types
using	left_singular_vector_tensor_type = LeftTensor
using	right_singular_vector_adjoint_tensor_type = RightAdjointTensor
using	singular_value_tensor_type = SingularValueTensor
using	truncation_info_type = TruncationInfo

Public Attributes
LeftTensor	left_singular_vectors
RightAdjointTensor	right_singular_vectors_adjoint
SingularValueTensor	singular_values
TruncationInfo	truncation

Detailed Description

template<class LeftTensor, class SingularValueTensor, class RightAdjointTensor, class TruncationInfo>
struct uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >

Owning factors and statistics returned by truncated_svd.

Aggregate member order supports auto [u, s, vh, info] = truncated_svd(matrix, policy).

Member Typedef Documentation

left_singular_vector_tensor_type

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

using uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::left_singular_vector_tensor_type = LeftTensor

right_singular_vector_adjoint_tensor_type

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

using uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::right_singular_vector_adjoint_tensor_type = RightAdjointTensor

singular_value_tensor_type

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

using uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::singular_value_tensor_type = SingularValueTensor

truncation_info_type

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

using uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::truncation_info_type = TruncationInfo

Member Data Documentation

left_singular_vectors

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

LeftTensor uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::left_singular_vectors

right_singular_vectors_adjoint

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

RightAdjointTensor uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::right_singular_vectors_adjoint

singular_values

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

SingularValueTensor uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::singular_values

truncation

template<class LeftTensor , class SingularValueTensor , class RightAdjointTensor , class TruncationInfo >

TruncationInfo uni20::linalg::TruncatedSvdResult< LeftTensor, SingularValueTensor, RightAdjointTensor, TruncationInfo >::truncation

---

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

• ops/truncated_svd.hpp