Skip to main content

SignalValue

Enum SignalValue 

Source
pub enum SignalValue {
    Scalar(f64),
    Vector(Vec<f64>),
}
Expand description

The value one named block produces (or one Signal resolves to) at a given step: a bare scalar — everything this graph supported before this variant existed — or a fixed-length vector of scalars. Arity is fixed once a block declares it (known at graph-build time from its own parameters, e.g. a matrix Gain’s own row count, a Const vector literal’s own length, StateSpace’s own C row count) — there is no dynamic/runtime-determined length.

No type tagging beyond Scalar/Vector exists, or is needed. This graph has never had a bool type, even for scalars — a “boolean” signal (a Hysteresis output, a PWM main/complement output) has always just been an f64 interpreted via a >= 0.5 threshold by whatever reads it. A Vector’s own elements are exactly as untyped as a scalar signal already was; nothing tracked “this element is really a voltage” vs. “this element is really a gate command” before, and nothing needs to start now.

Which BlockKinds accept/produce a Vector, and the exact broadcast/reduction/rejection rule for each, is a per-block-kind decision worked out in general-simulator’s own book/dev-guide/src/vector-signals.md.

Variants§

§

Scalar(f64)

A single number.

§

Vector(Vec<f64>)

A fixed-length bundle of numbers.

Implementations§

Source§

impl SignalValue

Source

pub fn len(&self) -> usize

1 for a Scalar, the element count for a Vector.

Source

pub fn is_empty(&self) -> bool

true only for an empty Vector (a Scalar is always length 1).

Source

pub fn as_scalar(&self) -> Option<f64>

Some(x) for a Scalar, None for a Vector — the check every scalar-only BlockKind makes on each of its own inputs before doing anything else.

Source

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

This value’s own elements, in order, as a plain slice — a Scalar is a length-1 slice. The flattening primitive every input-bundling block (cscript, statespace, CoordinateTransform, Pmsm) builds its own input vector from: several SignalValues, scalar or vector, concatenated in declared order.

Trait Implementations§

Source§

impl Clone for SignalValue

Source§

fn clone(&self) -> SignalValue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SignalValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SignalValue

Source§

fn eq(&self, other: &SignalValue) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SignalValue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.