Skip to main content

SVEResult

Struct SVEResult 

Source
pub struct SVEResult { /* private fields */ }
Expand description

Result of Singular Value Expansion computation

Implementations§

Source§

impl SVEResult

Source

pub fn u(&self) -> &PiecewiseLegendrePolyVector

Left singular functions, one per singular value

Source

pub fn s(&self) -> &[f64]

Singular values, in non-increasing order

Source

pub fn v(&self) -> &PiecewiseLegendrePolyVector

Right singular functions, one per singular value

Source

pub fn epsilon(&self) -> f64

Accuracy the expansion was computed to

Source

pub fn from_discretized_matrix<T: CustomNumeric + 'static>( matrix: &Mat<T>, gauss_x: &Rule<T>, gauss_y: &Rule<T>, segments_x: &[f64], segments_y: &[f64], n_gauss: usize, epsilon: f64, ) -> Result<Self, Error>

Build an SVE from a kernel matrix discretized on the Gauss points of segments_x x segments_y

matrix[i][j] is sqrt(w_x[i]) * K(x[i], y[j]) * sqrt(w_y[j]) for the piecewise Gauss-Legendre rules gauss_x and gauss_y of n_gauss points per segment, so matrix has n_gauss * n_segments rows and columns. The weights are divided out of the singular vectors before they become piecewise Legendre polynomials.

§Errors
Source

pub fn from_discretized_matrices_centrosymmetric<T: CustomNumeric + 'static>( even: &Mat<T>, odd: &Mat<T>, gauss_x: &Rule<T>, gauss_y: &Rule<T>, segments_x: &[f64], segments_y: &[f64], n_gauss: usize, _xmax: f64, _ymax: f64, epsilon: f64, ) -> Result<Self, Error>

Self::from_discretized_matrix for a centrosymmetric kernel, whose even and odd parts are discretized on the half domains segments_x x segments_y and extended to [-xmax, xmax] and [-ymax, ymax]

xmax and ymax are unused: the domains follow from the segments.

A block of rank 0 (the odd part of a kernel that is even in y, say) contributes no singular function; only both blocks being empty is an error.

The decomposition runs in T, like Self::from_discretized_matrix: a Df64 matrix keeps its low-order parts through the SVD and is narrowed to f64 only when the singular vectors become piecewise Legendre polynomials (which are f64).

§Errors
  • The errors of Self::from_discretized_matrix for each block, except that an empty block is accepted
  • The errors of the crate-internal extend_to_full_domain and merge_results, in particular Error::EmptyInput if both blocks are empty
Source

pub fn new( u: PiecewiseLegendrePolyVector, s: Vec<f64>, v: PiecewiseLegendrePolyVector, epsilon: f64, ) -> Result<Self, Error>

Create a new SVEResult

§Errors
Source

pub fn truncate( &self, eps: Option<f64>, max_size: Option<usize>, ) -> Result<Self, Error>

The expansion truncated to the singular values ≥ eps times the largest one, at most max_size of them

eps is Self::epsilon by default, and is the accuracy of the result. At least the largest singular value is kept, since eps < 1.

§Errors

Trait Implementations§

Source§

impl Clone for SVEResult

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SVEResult

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.