Skip to main content

SVEOptions

Struct SVEOptions 

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

Options of compute_sve_with

SVEOptions::new gives the defaults: the best accuracy of the working precision, which is chosen from the accuracy (TworkType::Auto), every singular value above 2 * machine epsilon of it, and the even/odd expansion of a centrosymmetric kernel. Each method sets one option:

use sparse_ir_sve::{SVEOptions, TworkType};

let options = SVEOptions::new()
    .epsilon(1e-10)
    .max_num_svals(50)
    .twork(TworkType::Float64X2);

Implementations§

Source§

impl SVEOptions

Source

pub fn new() -> SVEOptions

The default options

Source

pub fn epsilon(self, epsilon: f64) -> SVEOptions

Required accuracy, in (0, 1); by default the best accuracy of the working precision (about 1.6e-16 in Float64X2)

Source

pub fn cutoff(self, cutoff: f64) -> SVEOptions

Relative cutoff, in [0, 1]: the singular values below cutoff times the largest one are discarded

By default 2 * machine epsilon of the working precision, about 4.44e-16 in Float64 and 4.93e-32 in Float64X2 (the libsparseir default). The SVD of each block already discards the singular values below 2 * machine epsilon times its largest one, so a smaller cutoff has little effect. Replaces Self::cutoff_from_epsilon.

Source

pub fn cutoff_from_epsilon(self) -> SVEOptions

Keep only the singular values that an expansion accurate to epsilon uses

Truncates the spectrum at max(2 * machine epsilon, f * epsilon) times the largest singular value, with f = ACCURACY_CUTOFF_FACTOR. In Float64X2 (epsilon below about 1e-8) the block SVDs stop there, which is about 1.5 to 2.3 times faster than the default, with about 20% fewer singular values. In Float64 the result is that of the default truncated at the cutoff, which for epsilon ≤ 4.4e-6 is the same result.

The singular values ≥ epsilon times the largest one, plus one more, agree with those of the default to about 1e-10 relative, not to the working precision. Replaces Self::cutoff.

Source

pub fn max_num_svals(self, max_num_svals: usize) -> SVEOptions

Maximum number of singular values to keep, positive

Source

pub fn twork(self, twork: TworkType) -> SVEOptions

Working precision; by default chosen from the accuracy (TworkType::Auto)

Source

pub fn full_domain(self, full_domain: bool) -> SVEOptions

Whether to expand a centrosymmetric kernel over its full domain, without exploiting its symmetry; false by default

The singular values agree with the even/odd expansion up to rounding, but the SVD is taken of one matrix with twice as many rows and columns as each even/odd block (about four times the work), the singular functions have no parity, and those of (nearly) degenerate singular values may mix the even and odd sectors. Other kernels are always expanded over their full domain.

Trait Implementations§

Source§

impl Clone for SVEOptions

Source§

fn clone(&self) -> SVEOptions

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 Copy for SVEOptions

Source§

impl Debug for SVEOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SVEOptions

Source§

fn default() -> SVEOptions

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SVEOptions

Source§

fn eq(&self, other: &SVEOptions) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SVEOptions

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
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

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.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V