#[non_exhaustive]pub struct EighOptions {
pub gauge: EighGauge,
pub derivative_eps: f64,
pub driver: EighDriver,
pub batch_policy: EighBatchPolicy,
}Expand description
Options for Hermitian eigenvalue decomposition.
§Examples
use tenferro_linalg::{EighDriver, EighOptions};
let options = EighOptions::default()
.derivative_eps(1.0e-10)
.driver(EighDriver::Jacobi);
assert_eq!(options.derivative_eps, 1.0e-10);
assert_eq!(options.driver, EighDriver::Jacobi);Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.gauge: EighGaugeEigenvector gauge convention.
derivative_eps: f64AD derivative regularization for repeated or nearly repeated eigenvalues.
driver: EighDriverAlgorithm family for the eigensolver; a provider may ignore it.
batch_policy: EighBatchPolicyWhether a real batch may fall back to one launch per matrix.
Implementations§
Source§impl EighOptions
impl EighOptions
Sourcepub fn gauge(self, gauge: EighGauge) -> Self
pub fn gauge(self, gauge: EighGauge) -> Self
Return options with the requested eigenvector gauge.
§Examples
use tenferro_linalg::{EighGauge, EighOptions};
let options = EighOptions::default().gauge(EighGauge::CanonicalPivot);
assert_eq!(options.gauge, EighGauge::CanonicalPivot);Sourcepub fn derivative_eps(self, derivative_eps: f64) -> Self
pub fn derivative_eps(self, derivative_eps: f64) -> Self
Return options with an explicit derivative epsilon.
§Examples
use tenferro_linalg::EighOptions;
let options = EighOptions::default().derivative_eps(1.0e-9);
assert_eq!(options.derivative_eps, 1.0e-9);Sourcepub fn driver(self, driver: EighDriver) -> Self
pub fn driver(self, driver: EighDriver) -> Self
Return options with an explicit eigensolver driver.
§Examples
use tenferro_linalg::{EighDriver, EighOptions};
let options = EighOptions::default().driver(EighDriver::DivideAndConquer);
assert_eq!(options.driver, EighDriver::DivideAndConquer);Sourcepub fn batch_policy(self, batch_policy: EighBatchPolicy) -> Self
pub fn batch_policy(self, batch_policy: EighBatchPolicy) -> Self
Return options that refuse the per-matrix fallback for a real batch.
§Examples
use tenferro_linalg::{EighBatchPolicy, EighOptions};
let options = EighOptions::default().batch_policy(EighBatchPolicy::RequireBatched);
assert_eq!(options.batch_policy, EighBatchPolicy::RequireBatched);Trait Implementations§
Source§impl Clone for EighOptions
impl Clone for EighOptions
impl Copy for EighOptions
Source§impl Debug for EighOptions
impl Debug for EighOptions
Source§impl Default for EighOptions
impl Default for EighOptions
Source§impl PartialEq for EighOptions
impl PartialEq for EighOptions
impl StructuralPartialEq for EighOptions
Auto Trait Implementations§
impl Freeze for EighOptions
impl RefUnwindSafe for EighOptions
impl Send for EighOptions
impl Sync for EighOptions
impl Unpin for EighOptions
impl UnsafeUnpin for EighOptions
impl UnwindSafe for EighOptions
Blanket Implementations§
impl<T> Boilerplate for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T, U> Imply<T> for U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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