Struct rgsl::types::interpolation::Interp

pub struct Interp { /* fields omitted */ }

Implementations

impl Interp

pub fn new(t: InterpType, size: usize) -> Option<Interp>

This function returns a pointer to a newly allocated interpolation object of type T for size data-points.

use rgsl::{Interp, InterpType};

let interp_type = InterpType::linear();
let interp = Interp::new(interp_type, 2).expect("Failed to initialize `Interp`...");

pub fn init(&mut self, xa: &[f64], ya: &[f64]) -> Value

This function initializes the interpolation object interp for the data (xa,ya) where xa and ya are arrays of size size. The interpolation object (gsl_interp) does not save the data arrays xa and ya and only stores the static state computed from the data. The xa data array is always assumed to be strictly ordered, with increasing x values; the behavior for other arrangements is not defined.

Asserts that ya.len() >= xa.len().

pub fn name(&self) -> String

This function returns the name of the interpolation type used by interp. For example,

use rgsl::{Interp, InterpType};

let interp_type = InterpType::linear();
let interp = Interp::new(interp_type, 2).expect("Failed to initialize `Interp`...");
println!("interp uses '{}' interpolation.", interp.name());

would print something like :

interp uses 'cspline' interpolation.

pub fn min_size(&self) -> u32

This function returns the minimum number of points required by the interpolation object interp or interpolation type T. For example, Akima spline interpolation requires a minimum of 5 points.

Trait Implementations

impl Drop for Interp

fn drop(&mut self)

Executes the destructor for this type.