pub struct PiecewiseLegendrePoly { /* private fields */ }Expand description
A single piecewise Legendre polynomial
Implementations§
Source§impl PiecewiseLegendrePoly
impl PiecewiseLegendrePoly
Sourcepub fn new(
data: Mat<f64>,
knots: Vec<f64>,
l: i32,
delta_x: Option<Vec<f64>>,
symm: i32,
) -> Result<Self, Error>
pub fn new( data: Mat<f64>, knots: Vec<f64>, l: i32, delta_x: Option<Vec<f64>>, symm: i32, ) -> Result<Self, Error>
Create a new PiecewiseLegendrePoly from data and knots
data holds the Legendre coefficients, one column per segment; the
nsegments + 1 knots bound the segments. delta_x (the segment
widths) is computed from the knots when None. symm is the parity of
the polynomial: 1 (even), -1 (odd) or 0 (no definite parity).
§Errors
Error::EmptyInputifdatahas no row or no columnError::InvalidParameterifknotsdoes not have one entry more thandatahas columns, a knot is not finite, or a segment lengthknots[i] - knots[i - 1]is not a positive normal double (this includes decreasing knots, NaN, lengths that overflow and subnormal lengths); or ifdelta_xdoes not have one entry per segment or differs from the knot spacingeby more thanmax(1e-10 * |e|, 8 * f64::EPSILON * max(|knots[i]|, |knots[i + 1]|))Error::InvalidParameterifsymmis not -1, 0 or 1
Sourcepub fn rescale_domain(
&self,
new_knots: Vec<f64>,
new_delta_x: Option<Vec<f64>>,
new_symm: Option<i32>,
) -> Result<Self, Error>
pub fn rescale_domain( &self, new_knots: Vec<f64>, new_delta_x: Option<Vec<f64>>, new_symm: Option<i32>, ) -> Result<Self, Error>
Rescale domain: create a new polynomial with the same data but different knots
This is useful for transforming from one domain to another, e.g., from [-1, 1] to [0, b].
§Arguments
new_knots- New knot pointsnew_delta_x- Optional new segment widths (computed from knots if None)new_symm- Optional new symmetry parameter (keeps old if None)
§Returns
New polynomial with rescaled domain
§Errors
The errors of new for the new knots and widths
Sourcepub fn scale_data(&self, factor: f64) -> Self
pub fn scale_data(&self, factor: f64) -> Self
Sourcepub fn evaluate(&self, x: f64) -> f64
pub fn evaluate(&self, x: f64) -> f64
Evaluate the polynomial at a given point
§Panics
Panics if x is outside [xmin, xmax] or NaN; see Self::try_evaluate.
Sourcepub fn try_evaluate(&self, x: f64) -> Result<f64, Error>
pub fn try_evaluate(&self, x: f64) -> Result<f64, Error>
Self::evaluate returning an error instead of panicking
§Errors
Error::OutOfDomain if x is outside [xmin, xmax] or NaN
Sourcepub fn evaluate_many(&self, xs: &[f64]) -> Vec<f64>
pub fn evaluate_many(&self, xs: &[f64]) -> Vec<f64>
Evaluate the polynomial at multiple points
§Panics
Panics if a point is outside [xmin, xmax] or NaN; see
Self::try_evaluate_many.
Sourcepub fn try_evaluate_many(&self, xs: &[f64]) -> Result<Vec<f64>, Error>
pub fn try_evaluate_many(&self, xs: &[f64]) -> Result<Vec<f64>, Error>
Self::evaluate_many returning an error instead of panicking
§Errors
Error::OutOfDomain for the first point of xs that is outside
[xmin, xmax] or NaN; no point is evaluated then
Sourcepub fn split(&self, x: f64) -> (usize, f64)
pub fn split(&self, x: f64) -> (usize, f64)
Split x into segment index and normalized x
§Panics
Panics if x is outside [xmin, xmax] or NaN; see Self::try_split.
Sourcepub fn try_split(&self, x: f64) -> Result<(usize, f64), Error>
pub fn try_split(&self, x: f64) -> Result<(usize, f64), Error>
Self::split returning an error instead of panicking
§Errors
Error::OutOfDomain if x is outside [xmin, xmax] or NaN
Sourcepub fn deriv(&self, n: usize) -> Self
pub fn deriv(&self, n: usize) -> Self
Compute derivative of the polynomial
The result has polyorder equal to the number of its coefficient rows
(at least 1).
Sourcepub fn derivs(&self, x: f64) -> Vec<f64>
pub fn derivs(&self, x: f64) -> Vec<f64>
Compute derivatives at a point x
Returns the values of the derivatives of order 0 to polyorder - 1.
§Panics
Panics if x is outside [xmin, xmax] or NaN; see Self::try_derivs.
Sourcepub fn try_derivs(&self, x: f64) -> Result<Vec<f64>, Error>
pub fn try_derivs(&self, x: f64) -> Result<Vec<f64>, Error>
Self::derivs returning an error instead of panicking
§Errors
Error::OutOfDomain if x is outside [xmin, xmax] or NaN
Sourcepub fn l(&self) -> i32
pub fn l(&self) -> i32
Index of the function in its sequence of singular functions (0-based, in order of non-increasing singular value)
Trait Implementations§
Source§impl Clone for PiecewiseLegendrePoly
impl Clone for PiecewiseLegendrePoly
Auto Trait Implementations§
impl Freeze for PiecewiseLegendrePoly
impl RefUnwindSafe for PiecewiseLegendrePoly
impl Send for PiecewiseLegendrePoly
impl Sync for PiecewiseLegendrePoly
impl Unpin for PiecewiseLegendrePoly
impl UnsafeUnpin for PiecewiseLegendrePoly
impl UnwindSafe for PiecewiseLegendrePoly
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.