Back to Eqiora docs Skip to main content

ExpressionType

eqiora::kernel::typing

Struct ExpressionType 

pub struct ExpressionType<I> {
    pub value_type: ValueType,
    pub support: Option<SpatialSupport<I>>,
}
Description

Complete static type of one residual-expression value.

Fields§

§value_type: ValueType

Checked mathematical type, independent of execution choices.

§support: Option<SpatialSupport<I>>

Nominal spatial support, absent for global scalars.

Implementations§

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn require( self, value: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:requireExpressionTypeResultExpressionTypeTypeViolation

Type a Boolean domain condition without changing its required value type.

pub fn select( self, then_value: ExpressionType<I>, else_value: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:selectExpressionTypeExpressionTypeResultExpressionTypeTypeViolation

Type both value arms and the Boolean condition, without promotion.

pub fn equation( self, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:equationExpressionTypeResultExpressionTypeTypeViolation

Validate both sides of an equation without performing arithmetic.

pub fn compare( self, op: ComparisonOp, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:compareComparisonOpExpressionTypeResultExpressionTypeTypeViolation

Type a scalar comparison, with no discrete-to-real promotion.

pub fn logical_not(self) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:logical_notResultExpressionTypeTypeViolation

Type Boolean negation.

pub fn and( self, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:andExpressionTypeResultExpressionTypeTypeViolation

Type Boolean conjunction.

pub fn or( self, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:orExpressionTypeResultExpressionTypeTypeViolation

Type Boolean disjunction.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn array( elements: &[ExpressionType<I>], ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:arrayExpressionTypeResultExpressionTypeTypeViolation

Construct an outer channel axis from complete elements with compatible supports.

§

impl<I> ExpressionType<I>
where I: Clone,

Signature links:§ExpressionTypeClone

pub fn index(self, index: u32) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:indexu32ResultExpressionTypeTypeViolation

Select an outer channel; Cartesian component axes are not channel axes.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn complex( self, imag: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:complexExpressionTypeResultExpressionTypeTypeViolation

Construct a complex scalar, preserving physical dimension and compatible support.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn coordinate_partial( &self, selected: &ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:coordinate_partialExpressionTypeResultExpressionTypeTypeViolation

Type a real scalar partial derivative with respect to a coordinate.

The caller must establish that the selector is a coordinate symbol; this rule checks its support, the component types, and the resulting units.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn finite_unary( self, operation: FiniteUnaryOperation, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:finite_unaryFiniteUnaryOperationResultExpressionTypeTypeViolation

Type coordinate dualization, a map transpose, or an orthonormal adjoint.

pub fn finite_binary( self, operation: FiniteBinaryOperation, right: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:finite_binaryFiniteBinaryOperationExpressionTypeResultExpressionTypeTypeViolation

Type application, composition, or bilinear pairing; the endpoint bases must match.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn sum( self, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:sumExpressionTypeResultExpressionTypeTypeViolation

Type arithmetic addition, including a count plus same-basis signed change.

pub fn ordinal(self) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:ordinalResultExpressionTypeTypeViolation

Explicitly project a nominal index to its dimensionless integer ordinal.

pub fn integer_quotient( self, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:integer_quotientExpressionTypeResultExpressionTypeTypeViolation

Type a checked integer quotient or remainder, without real promotion.

pub fn to_real(self) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:to_realResultExpressionTypeTypeViolation

Explicitly convert an integer scalar to a dimensionless real scalar.

pub fn to_integer(self) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:to_integerResultExpressionTypeTypeViolation

Type a checked real-to-integer conversion. Whether the value is integral and in range is checked during evaluation.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn ordered_selection( self, other: ExpressionType<I>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:ordered_selectionExpressionTypeResultExpressionTypeTypeViolation

Type a minimum or maximum, without numeric promotion or dimension changes. Only ordinary invariant real or integer scalars are ordered. On a tie the first operand is selected; both operands stay in the dependency graph.

§

impl<I> ExpressionType<I>
where I: Clone + Eq,

Signature links:§ExpressionTypeCloneEq

pub fn pullback( &self, source: &[ExpressionType<I>], at: &[(ExpressionType<I>, ExpressionType<I>)], ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:pullbackExpressionTypeExpressionTypeExpressionTypeResultExpressionTypeTypeViolation

Infer scalar pullback units and support from resolved coordinate types. The syntax or DAG layer separately checks that the selectors are a complete set of unique coordinate references, not arbitrary scalar expressions.

§

impl<I> ExpressionType<I>

Signature links:§ExpressionType

pub fn new( value_type: ValueType, support: Option<SpatialSupport<I>>, ) -> ExpressionType<I>

Signature links:newValueTypeOptionSpatialSupportExpressionType

Attach a support to an already checked mathematical type.

pub fn scalar( dimension: DimExponents, support: Option<SpatialSupport<I>>, ) -> ExpressionType<I>

Signature links:scalarDimExponentsOptionSpatialSupportExpressionType

An invariant real scalar with the supplied dimension and support.

pub fn shaped( dimension: DimExponents, shape: ValueShape, frame: ValueFrame, support: Option<SpatialSupport<I>>, ) -> Result<ExpressionType<I>, InvalidValueType>

Signature links:shapedDimExponentsValueShapeValueFrameOptionSpatialSupportResultExpressionTypeInvalidValueType

A real value with the given mathematical shape, frame, and support.

§Errors

Rejects an invalid shape and frame combination or an unrepresentable component count.

pub const fn dimension(&self) -> DimExponents

Signature links:dimensionDimExponents

Physical dimension.

pub const fn shape(&self) -> &ValueShape

Signature links:shapeValueShape

Mathematical component shape.

pub const fn frame(&self) -> ValueFrame

Signature links:frameValueFrame

Component-frame meaning.

§

impl<I> ExpressionType<I>
where I: Clone + PartialEq,

Signature links:§ExpressionTypeClonePartialEq

pub fn coordinate( factor: &I, axis: usize, relation: Option<&SpatialSupport<I>>, ) -> Result<ExpressionType<I>, TypeViolation<I>>

Signature links:coordinate&IusizeOptionSpatialSupportResultExpressionTypeTypeViolation

Type one factor axis, keeping the projection’s declared support.

Trait Implementations§

§

impl<I> Clone for ExpressionType<I>
where I: Clone,

Signature links:§CloneExpressionTypeClone
§

fn clone(&self) -> ExpressionType<I>

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

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

Signature links:unstableSource§clone_from
Performs copy-assignment from source. Read more
§

impl<I> Debug for ExpressionType<I>
where I: Debug,

Signature links:§DebugExpressionTypeDebug
§

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

Signature links:§fmtFormatterResult()Error
Formats the value using the given formatter. Read more
§

impl<I> PartialEq for ExpressionType<I>
where I: PartialEq,

Signature links:§PartialEqExpressionTypePartialEq
§

fn eq(&self, other: &ExpressionType<I>) -> bool

Signature links:§eqExpressionTypebool
Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§ne&Rhsbool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<I> Eq for ExpressionType<I>
where I: Eq,

§

impl<I> StructuralPartialEq for ExpressionType<I>

Auto Trait Implementations§

§

impl<I> Freeze for ExpressionType<I>
where I: Freeze,

§

impl<I> RefUnwindSafe for ExpressionType<I>
where I: RefUnwindSafe,

§

impl<I> Send for ExpressionType<I>
where I: Send,

§

impl<I> Sync for ExpressionType<I>
where I: Sync,

§

impl<I> Unpin for ExpressionType<I>
where I: Unpin,

§

impl<I> UnsafeUnpin for ExpressionType<I>
where I: UnsafeUnpin,

§

impl<I> UnwindSafe for ExpressionType<I>
where I: UnwindSafe,

Blanket Implementations§

Source§

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

Signature links:Source§AnySized
Source§

fn type_id(&self) -> TypeId

Signature links:Source§type_idTypeId
Gets the TypeId of self. Read more
§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Signature links:§Result
Convert the given value into an approximately equivalent representation.
§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

Signature links:§
§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Signature links:§Result
Convert the subject into an approximately equivalent representation.
Source§

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

Signature links:Source§BorrowSized
Source§

fn borrow(&self) -> &T

Signature links:Source§borrow&T
Immutably borrows from an owned value. Read more
Source§

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

Signature links:Source§BorrowMutSized
Source§

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

Signature links:Source§borrow_mut&mut T
Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

Signature links:§
§

fn by_ref(&self) -> &T

Source§

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

Signature links:Source§CloneToUninitClone
Source§

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

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

impl<T, Dst> ConvAsUtil<Dst> for T

Signature links:§
§

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject with the default scheme.
§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject with a specific scheme.
§

impl<T> ConvUtil for T

Signature links:§
§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject to a given type with the default scheme.
§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject to a given type with a specific scheme.
§

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Signature links:§SizedInto
Convert the subject to a given type.
§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Signature links:§ResultSized
Attempt to convert the subject to a given type.
§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Signature links:§ResultSized
Attempt a value conversion of the subject to a given type.
§

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

Signature links:§Sized
§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Signature links:§EqSizedBorrowSized
§

fn equivalent(&self, key: &K) -> bool

Signature links:§&Kbool
Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Signature links:§EqSizedBorrowSized
§

fn equivalent(&self, key: &K) -> bool

Signature links:§&Kbool
Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Signature links:§EqSizedBorrowSized
§

fn equivalent(&self, key: &K) -> bool

Signature links:§&Kbool
Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Signature links:Source§From
Source§

fn from(t: T) -> T

Signature links:Source§from

Returns the argument unchanged.

§

impl<T> Instrument for T

Signature links:§
§

fn instrument(self, span: Span) -> Instrumented<Self>

Signature links:§
Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Signature links:§
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Signature links:Source§IntoFrom
Source§

fn into(self) -> U

Signature links:Source§into

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Signature links:Source§IntoEither
Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Signature links:Source§into_eitherboolEither
Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Signature links:Source§into_either_withEitherFnOncebool
Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

Signature links:§
§

const ALIGN: usize

Signature links:§usize
The alignment of pointer.
§

type Init = T

Signature links:§
The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Signature links:§usize
Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Signature links:§usize&'a T
Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Signature links:§usize&'a mut T
Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Signature links:§usize
Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Signature links:Source§Same
Source§

type Output = T

Signature links:Source§Output
Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Signature links:§
§

fn to_subset(&self) -> Option<SS>

Signature links:§Option
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Signature links:§bool
Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Signature links:§
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

Signature links:§&SS
The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Signature links:Source§ToOwnedClone
Source§

type Owned = T

Signature links:Source§Owned
The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Signature links:Source§to_owned
Creates owned data from borrowed data, usually by cloning. Read more
Source§

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

Signature links:Source§clone_into&mut T
Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<Src> TryFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Signature links:§Result
Convert the given value into the subject type.
Source§

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

Signature links:Source§TryFromInto
Source§

type Error = Infallible

Signature links:Source§ErrorInfallible
The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Signature links:Source§try_fromResultTryFromError
Performs the conversion.
§

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

Signature links:§
§

type Err = <Dst as TryFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Signature links:§Result
Convert the subject into the destination type.
Source§

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

Signature links:Source§TryIntoTryFrom
Source§

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

Signature links:Source§ErrorTryFromError
The type returned in the event of a conversion error.
Source§

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

Signature links:Source§try_intoResultTryFromError
Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Signature links:§
§

fn vzip(self) -> V

§

impl<Src> ValueFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Signature links:§Result
Convert the given value into an exactly equivalent representation.
§

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

Signature links:§
§

type Err = <Dst as ValueFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Signature links:§Result
Convert the subject into an exactly equivalent representation.
§

impl<T> WithSubscriber for T

Signature links:§
§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Signature links:§Into
Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Signature links:§
Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,