Struct ValueLiteral 

pub struct ValueLiteral { /* private fields */ }

A complete finite mathematical value, with domain-specific exact payloads.

Components follow the type’s shape in row-major, last-axis-fastest order. The type alone determines scalar domain, dimensions, shape, and frame.

Implementations

§

impl ValueLiteral

Signature links:ValueLiteral

pub fn enum_value( value_type: ValueType, tag: u32, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:enum_valueValueTypeu32ResultValueLiteralInvalidValueLiteral

Construct a checked member of one exact enum type, without numeric coercion.

pub const fn enum_tag(&self) -> Option<u32>

Signature links:enum_tagOptionu32

Internal declared member selector; no integer or ordinal conversion is implied.

pub fn boolean(value: bool) -> ValueLiteral

Signature links:booleanboolValueLiteral

Construct a logical truth value without integer or real coercion.

pub const fn as_bool(&self) -> Option<bool>

Signature links:as_boolOptionbool

Extract only a logical truth value; numeric zero and one are not Booleans.

pub fn new( value_type: ValueType, components: impl IntoIterator<Item = (f64, f64)>, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:newValueTypeIntoIteratorf64f64ResultValueLiteralInvalidValueLiteral

Construct all components of the declared mathematical type. Signed zeros normalize to positive zero; all-zero values store no buffer. Inputs with unknown length are read at most one past the required count.

Errors

Rejects incorrect cardinality, non-finite components, imaginary parts in real types, or component storage that cannot be allocated.

pub fn from_real( value_type: ValueType, value: f64, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:from_realValueTypef64ResultValueLiteralInvalidValueLiteral

Embed a real scalar or contextual zero into the declared type. A shaped contextual zero requires no shape-sized allocation or traversal.

Errors

Rejects non-finite values and nonzero scalar broadcasting to shaped types.

pub const fn value_type(&self) -> &ValueType

Signature links:value_typeValueType

Complete mathematical type, including scalar domain and component roles.

pub fn component_count(&self) -> usize

Signature links:component_countusize

Exact number of mathematical components, independent of storage.

pub fn component(&self, index: usize) -> Option<(f64, f64)>

Signature links:componentusizeOptionf64f64

One ordered real/imaginary pair, or None outside the exact shape.

pub fn components(&self) -> Option<impl ExactSizeIterator + DoubleEndedIterator>

Signature links:componentsOptionExactSizeIteratorDoubleEndedIterator

Components in row-major, last-axis-fastest order, without materializing zero storage.

pub const fn is_zero(&self) -> bool

Signature links:is_zerobool

Whether every numeric component is zero. Boolean false is not numeric zero.

pub fn real_scalar_value(&self) -> Option<DynQuantity>

Signature links:real_scalar_valueOptionDynQuantity

Extract a numerical quantity only for an invariant real scalar.

§

impl ValueLiteral

Signature links:ValueLiteral

pub fn array( elements: &[&ValueLiteral], ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:arrayValueLiteralResultValueLiteralInvalidValueLiteral

Pack complete compatible elements into one outer channel axis. Real elements may embed into complex elements; no scalar-to-array broadcast occurs.

Errors

Rejects empty inputs, incompatible types, invalid extents or allocation failure.

pub fn index(&self, index: u32) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:indexu32ResultValueLiteralInvalidValueLiteral

Select a complete element along the outermost channel axis. Spatial tensor axes are never interpreted as channel axes.

Errors

Rejects non-arrays, out-of-range indices or allocation failure.

§

impl ValueLiteral

Signature links:ValueLiteral

pub fn checked_equal( &self, other: &ValueLiteral, ) -> Result<bool, InvalidValueLiteral>

Signature links:checked_equalValueLiteralResultboolInvalidValueLiteral

Exact scalar equality without numeric Boolean or integer/real coercion. Real and complex quantities share equality only at equal dimensions and frames; nominal indexes require the same complete type. Arrays and counts are rejected.

pub fn checked_order( &self, other: &ValueLiteral, ) -> Result<Ordering, InvalidValueLiteral>

Signature links:checked_orderValueLiteralResultOrderingInvalidValueLiteral

Exact ordering of ordinary real or integer scalars, without cross-domain coercion. Complex values, Booleans, nominal indexes, counts, and arrays are rejected.

§

impl ValueLiteral

Signature links:ValueLiteral

pub fn integer( value_type: ValueType, components: impl IntoIterator<Item = i64>, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:integerValueTypeIntoIteratori64ResultValueLiteralInvalidValueLiteral

Construct exact integer components in row-major order, without real conversion. All-zero input uses compact storage; at most one excess input is consumed.

pub fn from_integer( value_type: ValueType, value: i64, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:from_integerValueTypei64ResultValueLiteralInvalidValueLiteral

Construct an integer scalar or compact contextual integer zero.

pub fn integer_component(&self, index: usize) -> Option<i64>

Signature links:integer_componentusizeOptioni64

Exact integer component, absent for other domains or out-of-range positions.

pub fn integer_components( &self, ) -> Option<impl ExactSizeIterator + DoubleEndedIterator>

Signature links:integer_componentsOptionExactSizeIteratorDoubleEndedIterator

Exact ordered integer components, absent for other domains.

pub fn integer_scalar_value(&self) -> Option<i64>

Signature links:integer_scalar_valueOptioni64

Extract only an exact invariant dimensionless integer scalar.

pub fn ordinal(&self) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:ordinalResultValueLiteralInvalidValueLiteral

Explicitly forget a checked index’s nominal set, retaining its exact ordinal.

pub fn checked_add( &self, other: &ValueLiteral, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:checked_addValueLiteralResultValueLiteralInvalidValueLiteral

Checked exact integer addition, with equal complete types and no broadcasting.

pub fn checked_sub( &self, other: &ValueLiteral, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:checked_subValueLiteralResultValueLiteralInvalidValueLiteral

Checked exact integer subtraction.

pub fn checked_mul( &self, other: &ValueLiteral, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:checked_mulValueLiteralResultValueLiteralInvalidValueLiteral

Checked exact integer multiplication.

pub fn checked_neg(&self) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:checked_negResultValueLiteralInvalidValueLiteral

Checked exact integer negation.

pub fn checked_quotient( &self, other: &ValueLiteral, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:checked_quotientValueLiteralResultValueLiteralInvalidValueLiteral

Integer quotient, truncating toward zero. A zero divisor and MIN / -1 are rejected.

pub fn checked_remainder( &self, other: &ValueLiteral, ) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:checked_remainderValueLiteralResultValueLiteralInvalidValueLiteral

Integer remainder with the dividend’s sign. A zero divisor and MIN % -1 are rejected.

pub fn to_real(&self) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:to_realResultValueLiteralInvalidValueLiteral

Explicit integer scalar to binary64, rounded once to nearest, ties to even.

pub fn to_integer(&self) -> Result<ValueLiteral, InvalidValueLiteral>

Signature links:to_integerResultValueLiteralInvalidValueLiteral

Convert only a finite dimensionless integral real scalar in the signed range.

§

impl ValueLiteral

Signature links:ValueLiteral

pub fn component_real( &self, index: usize, ) -> Result<DynQuantity, InvalidValueLiteral>

Signature links:component_realusizeResultDynQuantityInvalidValueLiteral

Real part of one declared row-major component, with the source dimension.

Errors

Rejects nonnumeric domains and indexes outside the exact shape.

pub fn component_imaginary( &self, index: usize, ) -> Result<DynQuantity, InvalidValueLiteral>

Signature links:component_imaginaryusizeResultDynQuantityInvalidValueLiteral

Imaginary part of one declared row-major component, with the source dimension.

Errors

Rejects nonnumeric domains and indexes outside the exact shape.

pub fn component_magnitude( &self, index: usize, ) -> Result<DynQuantity, InvalidValueLiteral>

Signature links:component_magnitudeusizeResultDynQuantityInvalidValueLiteral

Euclidean magnitude of one declared component, with the source dimension. No peak/RMS, power or probability interpretation is inferred.

Errors

Rejects nonnumeric domains, out-of-shape indexes and numerical overflow.

pub fn component_squared_magnitude( &self, index: usize, ) -> Result<DynQuantity, InvalidValueLiteral>

Signature links:component_squared_magnitudeusizeResultDynQuantityInvalidValueLiteral

Squared magnitude of one declared component, with the squared source dimension. This does not sum components or infer a physical normalization.

Errors

Rejects nonnumeric domains, out-of-shape indexes, derived-dimension overflow and numerical overflow.

pub fn component_phase( &self, index: usize, ) -> Result<Option<DynQuantity>, InvalidValueLiteral>

Signature links:component_phaseusizeResultOptionDynQuantityInvalidValueLiteral

Principal argument in radians (dimensionless), undefined exactly at zero. No threshold, phase unwrapping, or phasor convention is applied.

Errors

Rejects nonnumeric domains and indexes outside the exact shape.

Trait Implementations

§

impl Clone for ValueLiteral

Signature links:CloneValueLiteral

§

fn clone(&self) -> ValueLiteral

Signature links:cloneValueLiteral

Returns a duplicate of the value.

§

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

Signature links:unstableSourceclone_from

Performs copy-assignment from source.

§

impl Debug for ValueLiteral

Signature links:DebugValueLiteral

§

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

Signature links:fmtFormatterResult()Error

Formats the value using the given formatter.

§

impl PartialEq for ValueLiteral

Signature links:PartialEqValueLiteral

§

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

Signature links:eqValueLiteralbool

Tests for self and other values to be equal, and is used by ==.

§

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

Signature links:unstableSourcene&Rhsbool

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

§

impl TryFrom<DynQuantity> for ValueLiteral

Signature links:TryFromDynQuantityValueLiteral

§

type Error = InvalidValueLiteral

Signature links:ErrorInvalidValueLiteral

The type returned in the event of a conversion error.

§

fn try_from( value: DynQuantity, ) -> Result<ValueLiteral, <ValueLiteral as TryFrom<DynQuantity>>::Error>

Signature links:try_fromDynQuantityResultValueLiteralValueLiteralTryFromDynQuantityError

Performs the conversion.

impl StructuralPartialEq for ValueLiteral