Struct substrate::simulation::waveform::WaveformRef

pub struct WaveformRef<'a, T> { /* private fields */ }

A time-dependent waveform that references data stored elsewhere.

Implementations

impl<'a, T> WaveformRef<'a, T>

pub fn new(t: &'a [T], x: &'a [T]) -> Self

Creates a new waveform referencing the given t and x data.

Panics

Panics if the two slices have different lengths.

Trait Implementations

impl<'a, T: Clone> Clone for WaveformRef<'a, T>

fn clone(&self) -> WaveformRef<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for WaveformRef<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Hash> Hash for WaveformRef<'a, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: Ord> Ord for WaveformRef<'a, T>

fn cmp(&self, other: &WaveformRef<'a, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a, T: PartialEq> PartialEq for WaveformRef<'a, T>

fn eq(&self, other: &WaveformRef<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, T: PartialOrd> PartialOrd for WaveformRef<'a, T>

fn partial_cmp(&self, other: &WaveformRef<'a, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T> TimeWaveform for WaveformRef<'a, T>

where T: Copy + Add<T, Output = T> + Div<T, Output = T> + PartialOrd + Sub<T, Output = T> + Mul<T, Output = T> + From<i32>,

type Data = T

The datatype of time and signal values in the waveform.

fn get(&self, idx: usize) -> Option<TimePoint<T>>

Get the value of the waveform at the given index.

fn len(&self) -> usize

Returns the number of time points in the waveform.

fn is_empty(&self) -> bool

Returns true if the waveform is empty.

fn first_t(&self) -> Option<Self::Data>

The time associated with the first point in the waveform.

fn first_x(&self) -> Option<Self::Data>

The value associated with the first point in the waveform.

fn last_t(&self) -> Option<Self::Data>

The time associated with the last point in the waveform.

fn last_x(&self) -> Option<Self::Data>

The value associated with the last point in the waveform.

fn first(&self) -> Option<TimePoint<Self::Data>>

The first point in the waveform.

fn last(&self) -> Option<TimePoint<Self::Data>>

The last point in the waveform.

fn edges(&self, threshold: Self::Data) -> Edges<'_, Self, Self::Data>

Returns an iterator over the edges in the waveform.

fn transitions( &self, low_threshold: Self::Data, high_threshold: Self::Data ) -> Transitions<'_, Self, Self::Data>

Returns an iterator over the transitions in the waveform.

fn values(&self) -> Values<'_, Self>

Returns an iterator over the values in the waveform.

fn time_index_before(&self, t: Self::Data) -> Option<usize>

Returns the index of the last point in the waveform with a time before t.

fn sample_at(&self, t: Self::Data) -> Self::Data

Retrieves the value of the waveform at the given time.

fn max_x(&self) -> Option<Self::Data>

Returns the maximum value seen in this waveform.

fn min_x(&self) -> Option<Self::Data>

Returns the minimum value seen in this waveform.

fn mid_x(&self) -> Option<Self::Data>

Returns the middle value seen in this waveform.

fn integral(&self) -> Self::Data

Returns the time integral of this waveform.

impl<'a, T: Copy> Copy for WaveformRef<'a, T>

impl<'a, T: Eq> Eq for WaveformRef<'a, T>

impl<'a, T> StructuralPartialEq for WaveformRef<'a, T>