Struct substrate::simulation::waveform::Waveform

pub struct Waveform<T> { /* private fields */ }

A time-dependent waveform that owns its data.

Implementations

impl<T> Waveform<T>

pub fn new() -> Self

Creates a new, empty waveform.

pub fn convert_into<U>(self) -> Waveform<U>

where T: Into<U>,

Converts the waveform’s datatype into another datatype.

pub fn with_initial_value(x: T) -> Self

where T: From<i32>,

Creates a new waveform with a single point (0, x).

pub fn push(&mut self, t: T, x: T)

where Self: TimeWaveform<Data = T>, T: PartialOrd,

Adds the given point to the waveform.

Trait Implementations

impl<T: Clone> Clone for Waveform<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Waveform<T>

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

Formats the value using the given formatter.

impl<T> Default for Waveform<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Waveform<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> FromIterator<(T, T)> for Waveform<T>

fn from_iter<I: IntoIterator<Item = (T, T)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for Waveform<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<T> Index<usize> for Waveform<T>

type Output = TimePoint<T>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Waveform<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Ord> Ord for Waveform<T>

fn cmp(&self, other: &Waveform<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<T: PartialEq> PartialEq for Waveform<T>

fn eq(&self, other: &Waveform<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<T: PartialOrd> PartialOrd for Waveform<T>

fn partial_cmp(&self, other: &Waveform<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<T> Serialize for Waveform<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.

impl<T> TimeWaveform for Waveform<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<T: Eq> Eq for Waveform<T>

impl<T> StructuralPartialEq for Waveform<T>