Struct SvdResult

Source

pub struct SvdResult<T: TensorScalar> {
    pub u: TypedTensor<T>,
    pub s: TypedTensor<T::Real>,
    pub vt: TypedTensor<T>,
}

Expand description

Result of SVD decomposition A = U * diag(S) * Vt.

The singular values are stored in a real-valued typed tensor, even when the input matrix is complex.

§Examples

use tensor4all_tensorbackend::svd_backend;
use tenferro::TypedTensor;

let a = TypedTensor::<f64>::from_vec(vec![2, 2], vec![1.0, 0.0, 0.0, 2.0]);
let result = svd_backend(&a).unwrap();

assert_eq!(result.u.shape, vec![2, 2]);
assert_eq!(result.s.shape, vec![2]);
assert_eq!(result.vt.shape, vec![2, 2]);

Fields§

§u: TypedTensor<T>

Left singular vectors.

§s: TypedTensor<T::Real>

Singular values.

§vt: TypedTensor<T>

Right singular vectors transposed.

Trait Implementations§

Source §

impl<T: Clone + TensorScalar> Clone for SvdResult<T>
where T::Real: Clone,

Source §

fn clone(&self) -> SvdResult<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl<T: Debug + TensorScalar> Debug for SvdResult<T>
where T::Real: Debug,

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for SvdResult<T>

§

impl<T> RefUnwindSafe for SvdResult<T>
where T: RefUnwindSafe, <T as TensorScalar>::Real: RefUnwindSafe,

§

impl<T> Send for SvdResult<T>

§

impl<T> Sync for SvdResult<T>

§

impl<T> Unpin for SvdResult<T>
where T: Unpin, <T as TensorScalar>::Real: Unpin,

§

impl<T> UnsafeUnpin for SvdResult<T>

§

impl<T> UnwindSafe for SvdResult<T>
where T: UnwindSafe, <T as TensorScalar>::Real: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

§

impl<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§