Struct PiecewiseLegendrePolyVector 

pub struct PiecewiseLegendrePolyVector { /* private fields */ }

Vector of piecewise Legendre polynomials

Implementations

impl PiecewiseLegendrePolyVector

pub fn new( polyvec: Vec<PiecewiseLegendrePoly>, ) -> Result<PiecewiseLegendrePolyVector, Error>

Constructor with a vector of PiecewiseLegendrePoly

Errors

• Error::EmptyInput if polyvec is empty
• Error::InvalidParameter if a polynomial has other knots or another data shape than the first: the accessors of the vector (get_knots, get_data, …) describe all of them by the first

pub fn get_polys(&self) -> &[PiecewiseLegendrePoly]

Get the polynomials

pub fn from_3d_data( data3d: Mat3<f64>, knots: Vec<f64>, symm: Option<Vec<i32>>, ) -> Result<PiecewiseLegendrePolyVector, Error>

Constructor with a 3D array, knots, and symmetry vector

data3d has the shape (polyorder, nsegments, npolys); polynomial i gets l = i and the symmetry symm[i] (0 if symm is None).

Errors

• Error::EmptyInput if data3d has no polynomial
• Error::InvalidParameter if symm does not have one entry per polynomial
• The errors of PiecewiseLegendrePoly::new for the data and knots

pub fn size(&self) -> usize

Get the size of the vector

pub fn rescale_domain( &self, new_knots: Vec<f64>, new_delta_x: Option<Vec<f64>>, new_symm: Option<Vec<i32>>, ) -> Result<PiecewiseLegendrePolyVector, Error>

Rescale domain for all polynomials in the vector

Creates a new PiecewiseLegendrePolyVector where each polynomial has the same data but new knots and delta_x.

Arguments

• new_knots - New knot points (same for all polynomials)
• new_delta_x - Optional new segment widths
• new_symm - Optional vector of new symmetry parameters (one per polynomial)

Returns

New vector with rescaled domains

Errors

• Error::InvalidParameter if new_symm does not have one entry per polynomial
• The errors of PiecewiseLegendrePoly::rescale_domain

pub fn scale_data(&self, factor: f64) -> PiecewiseLegendrePolyVector

Scale all data values by a constant factor

Multiplies the data of all polynomials by the same factor.

Arguments

• factor - Scaling factor to multiply all data by

Returns

New vector with scaled data

pub fn get(&self, index: usize) -> Option<&PiecewiseLegendrePoly>

Get polynomial by index (immutable)

pub fn get_mut(&mut self, index: usize) -> Option<&mut PiecewiseLegendrePoly>

👎Deprecated:

PiecewiseLegendrePolyVector is designed to be immutable. Use get() and create new instances for modifications.

Get polynomial by index (mutable) - deprecated, use immutable design instead

pub fn slice_single(&self, index: usize) -> Option<PiecewiseLegendrePolyVector>

Extract a single polynomial as a vector

pub fn slice_multi( &self, indices: &[usize], ) -> Result<PiecewiseLegendrePolyVector, Error>

Extract multiple polynomials by indices, in the order of indices

Errors

• Error::EmptyInput if indices is empty
• Error::InvalidParameter for the first index that is out of range or repeats an earlier one

pub fn evaluate_at(&self, x: f64) -> Vec<f64>

Evaluate all polynomials at a single point

Panics

Panics if x is outside the domain of a polynomial or NaN; see Self::try_evaluate_at.

pub fn try_evaluate_at(&self, x: f64) -> Result<Vec<f64>, Error>

Self::evaluate_at returning an error instead of panicking

Errors

Error::OutOfDomain if x is outside the domain of a polynomial or NaN

pub fn evaluate_at_many(&self, xs: &[f64]) -> Mat<f64>

Evaluate all polynomials at multiple points

The result has the shape (size, xs.len()).

Panics

Panics if a point is outside the domain of a polynomial or NaN; see Self::try_evaluate_at_many.

pub fn try_evaluate_at_many(&self, xs: &[f64]) -> Result<Mat<f64>, Error>

Self::evaluate_at_many returning an error instead of panicking

Errors

Error::OutOfDomain for the first point of xs that is outside the domain of a polynomial or NaN; every point is checked before any is evaluated

pub fn xmin(&self) -> f64

pub fn xmax(&self) -> f64

pub fn get_knots(&self, tolerance: Option<f64>) -> Vec<f64>

pub fn get_delta_x(&self) -> Vec<f64>

pub fn get_polyorder(&self) -> usize

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

pub fn get_symm(&self) -> Vec<i32>

pub fn get_data(&self) -> Mat3<f64>

Get data as 3D tensor: [segment][degree][polynomial]

pub fn roots(&self, tolerance: Option<f64>) -> Vec<f64>

Find roots of all polynomials

pub fn last(&self) -> &PiecewiseLegendrePoly

Get reference to last polynomial

C++ equivalent: u.polyvec.back()

pub fn nroots(&self, tolerance: Option<f64>) -> usize

Get the number of roots

Trait Implementations

impl Clone for PiecewiseLegendrePolyVector

fn clone(&self) -> PiecewiseLegendrePolyVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PiecewiseLegendrePolyVector

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

Formats the value using the given formatter.

impl Index<usize> for PiecewiseLegendrePolyVector

type Output = PiecewiseLegendrePoly

The returned type after indexing.

fn index( &self, index: usize, ) -> &<PiecewiseLegendrePolyVector as Index<usize>>::Output

Performs the indexing (container[index]) operation.