Struct ChunkedUnevenCore 

pub struct ChunkedUnevenCore<T> {
    pub times: Vec<f32>,
    pub values: Vec<T>,
}

The data core of a curve using uneven samples (i.e. keyframes), where each sample time yields some fixed number of values — the sampling width. This may serve as storage for curves that yield vectors or iterators, and in some cases, it may be useful for cache locality if the sample type can effectively be encoded as a fixed-length slice of values.

Fields

times: Vec<f32>

The times, one for each sample.

Invariants

This must always have a length of at least 2, be sorted, and have no duplicated or non-finite times.

values: Vec<T>

The values that are used in sampling. Each width-worth of these correspond to a single sample.

Invariants

The length of this vector must always be some fixed integer multiple of that of times.

Implementations

impl<T> ChunkedUnevenCore<T>

pub fn new( times: impl IntoIterator<Item = f32>, values: impl IntoIterator<Item = T>, width: usize, ) -> Result<Self, ChunkedUnevenCoreError>

Create a new ChunkedUnevenCore. The given times are sorted, filtered to finite times, and deduplicated. See the type-level documentation for more information about this type.

Produces an error in any of the following circumstances:

• width is zero.
• times has less than 2 unique valid entries.
• values has the incorrect length relative to times.

pub fn new_width_inferred( times: impl IntoIterator<Item = f32>, values: impl IntoIterator<Item = T>, ) -> Result<Self, ChunkedUnevenCoreError>

Create a new ChunkedUnevenCore, inferring the width from the sizes of the inputs. The given times are sorted, filtered to finite times, and deduplicated. See the type-level documentation for more information about this type. Prefer using new if possible, since that constructor has richer error checking.

Produces an error in any of the following circumstances:

• values has length zero.
• times has less than 2 unique valid entries.
• The length of values is not divisible by that of times (once sorted, filtered, and deduplicated).

The width is implicitly taken to be the length of values divided by that of times (once sorted, filtered, and deduplicated).

pub fn domain(&self) -> Interval

The domain of the curve derived from this core.

Panics

This may panic if this type’s invariants aren’t met.

pub const fn width(&self) -> usize

The sample width: the number of values that are contained in each sample.

pub fn sample_interp(&self, t: f32) -> InterpolationDatum<&[T]>

Given a time t, obtain a InterpolationDatum which governs how interpolation might recover a sample at time t. For example, when a Between value is returned, its contents can be used to interpolate between the two contained values with the given parameter. The other variants give additional context about where the value is relative to the family of samples.

pub fn sample_interp_timed(&self, t: f32) -> InterpolationDatum<(f32, &[T])>

Like sample_interp, but the returned values include the sample times. This can be useful when sample interpolation is not scale-invariant.

Trait Implementations

impl<T: Clone> Clone for ChunkedUnevenCore<T>

fn clone(&self) -> ChunkedUnevenCore<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ChunkedUnevenCore<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ChunkedUnevenCore<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for ChunkedUnevenCore<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.