LogLinearInterpolator

Struct LogLinearInterpolator 

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

Log-linear interpolation between data points.

Interpolates the natural logarithm of y values, then exponentiates the result. This is commonly used for discount factor interpolation as it:

  • Guarantees positive interpolated values
  • Produces piecewise constant forward rates

The interpolation formula is:

y(x) = exp(linear_interpolate(x, ln(y)))

§Example

use convex_math::interpolation::{LogLinearInterpolator, Interpolator};

// Discount factors at different maturities
let times = vec![0.0, 1.0, 2.0, 3.0];
let discount_factors = vec![1.0, 0.97, 0.94, 0.91];

let interp = LogLinearInterpolator::new(times, discount_factors).unwrap();
let df = interp.interpolate(1.5).unwrap();
assert!(df > 0.0);  // Always positive

Implementations§

Source§

impl LogLinearInterpolator

Source

pub fn new(xs: Vec<f64>, ys: Vec<f64>) -> MathResult<Self>

Creates a new log-linear interpolator.

§Arguments
  • xs - X coordinates (must be sorted in ascending order)
  • ys - Y coordinates (must all be positive)
§Errors

Returns an error if:

  • There are fewer than 2 points
  • Lengths differ
  • Any y value is non-positive
Source

pub fn with_extrapolation(self) -> Self

Enables extrapolation beyond the data range.

Source

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

Returns the original y values.

Trait Implementations§

Source§

impl Clone for LogLinearInterpolator

Source§

fn clone(&self) -> LogLinearInterpolator

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LogLinearInterpolator

Source§

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

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

impl Interpolator for LogLinearInterpolator

Source§

fn interpolate(&self, x: f64) -> MathResult<f64>

Returns the interpolated value at x.
Source§

fn derivative(&self, x: f64) -> MathResult<f64>

Returns the first derivative at x. Read more
Source§

fn allows_extrapolation(&self) -> bool

Returns true if extrapolation is allowed.
Source§

fn min_x(&self) -> f64

Returns the minimum x value in the data.
Source§

fn max_x(&self) -> f64

Returns the maximum x value in the data.
Source§

fn in_range(&self, x: f64) -> bool

Checks if x is within the interpolation range.

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

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

Source§

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

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

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

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

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.