Enum BoundaryCondition

pub enum BoundaryCondition<T, D: Dimension> {
    NotAKnot,
    Natural,
    Clamped,
    Periodic,
    Individual(Array<RowBoundary<T>, D>),
}

Boundary conditions for the whole dataset

The boundary condition is structured in three hirarchic enum’s:

• BoundaryCondition The toplevel boundary applys to the whole dataset
• RowBoundary applys to a single row in the dataset
• SingleBoundary applys to an individual boundary of a single row

the default is the NotAKnot boundary in each level

There are different possibilities for the boundary condition in each level:

• NotAKnot - all levels
• Natural - all levels (same as SecondDeriv(0.0))
• Clamped - all levels (same as FirstDeriv(0.0))
• Periodic - not in SingleBoundary
• FirstDeriv - only in SingleBoundary
• SecondDeriv - only in SingleBoundary

Example

In a complex case all boundaries can be set individually:

let y = array![
    [0.5, 1.0],
    [0.0, 1.5],
    [3.0, 0.5],
];
let x = array![-1.0, 0.0, 3.0];

// first data column: natural
// second data column top: NotAKnot
// second data column bottom: first derivative == 0.5
let boundaries = array![
    [
        RowBoundary::Natural,
        RowBoundary::Mixed { left: SingleBoundary::NotAKnot, right: SingleBoundary::FirstDeriv(0.5)}
    ],
];
let strat = CubicSpline::new().boundary(BoundaryCondition::Individual(boundaries));
let interpolator = Interp1DBuilder::new(y)
    .x(x)
    .strategy(strat)
    .build().unwrap();

Variants

NotAKnot

Not a knot boundary. The first and second segment at a curve end are the same polynomial.

Natural

Natural boundary. The second derivative at the curve end is 0

Clamped

Clamped boundary. The first derivative at the curve end is 0

Periodic

Periodic spline. The interpolated functions is assumed to be periodic. The first and last element in the data must be equal.

Individual(Array<RowBoundary<T>, D>)

Set individual boundary conditions for each row in the data and/or individual conditions for the left and right boundary

Trait Implementations

impl<T: Debug, D: Debug + Dimension> Debug for BoundaryCondition<T, D>

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

Formats the value using the given formatter.

impl<T, D: Dimension> Default for BoundaryCondition<T, D>

fn default() -> Self

Returns the “default value” for a type.

impl<T: PartialEq, D: PartialEq + Dimension> PartialEq for BoundaryCondition<T, D>

fn eq(&self, other: &BoundaryCondition<T, D>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq, D: Eq + Dimension> Eq for BoundaryCondition<T, D>

impl<T, D: Dimension> StructuralPartialEq for BoundaryCondition<T, D>