pub struct LameFunctionExt {
pub h2: f64,
pub k2: f64,
pub degree: usize,
pub species: usize,
pub config: LameConfig,
/* private fields */
}Expand description
Lamé function struct for computing ellipsoidal harmonics E_n^m(s).
Encapsulates the configuration and ellipsoid parameters for repeated evaluations.
Fields§
§h2: f64Ellipsoid parameter h² = a² - b²
k2: f64Ellipsoid parameter k² = a² - c²
degree: usizeDegree n
species: usizeSpecies index m (1-indexed: 1 to 2n+1)
config: LameConfigConfiguration
Implementations§
Source§impl LameFunction
impl LameFunction
Sourcepub fn new(
h2: f64,
k2: f64,
degree: usize,
species: usize,
config: LameConfig,
) -> Result<LameFunction, SpecialError>
pub fn new( h2: f64, k2: f64, degree: usize, species: usize, config: LameConfig, ) -> Result<LameFunction, SpecialError>
Create a new LameFunction for degree n and species m.
§Arguments
h2- Parameter h² = a² - b² (must be non-negative)k2- Parameter k² = a² - c² (must be >= h²)degree- Degree n (0 to 8)species- Species index m (1 to 2n+1)config- Configuration
§Returns
A new LameFunction or an error if parameters are invalid.
Sourcepub fn compute_eigenvalue(&mut self) -> Result<f64, SpecialError>
pub fn compute_eigenvalue(&mut self) -> Result<f64, SpecialError>
Compute the eigenvalue h (separation parameter) for this Lamé function.
Uses continued fraction / bisection for the eigenvalue of Bôcher’s equation.
Sourcepub fn evaluate(&mut self, s: f64) -> Result<LameResult, SpecialError>
pub fn evaluate(&mut self, s: f64) -> Result<LameResult, SpecialError>
Trait Implementations§
Source§impl Clone for LameFunction
impl Clone for LameFunction
Source§fn clone(&self) -> LameFunction
fn clone(&self) -> LameFunction
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for LameFunction
impl RefUnwindSafe for LameFunction
impl Send for LameFunction
impl Sync for LameFunction
impl Unpin for LameFunction
impl UnsafeUnpin for LameFunction
impl UnwindSafe for LameFunction
Blanket Implementations§
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.