Skip to main content

Series

Struct Series 

Source
pub struct Series<A: SerialAlphabet> { /* private fields */ }
Expand description

An ordered series of alphabet symbols validated against an aggregate rule.

Implementations§

Source§

impl<A: SerialAlphabet> Series<A>

Source

pub fn try_new( alphabet: A, rule: AggregateRule, order: Vec<A::Symbol>, ) -> Result<Self, SeriesError>

Constructs a series after validating alphabet, membership, and aggregate policy.

Source

pub fn alphabet(&self) -> &A

Returns the alphabet value retained by this series.

Source

pub fn rule(&self) -> &AggregateRule

Returns the aggregate rule retained by this series.

Source

pub fn order(&self) -> &[A::Symbol]

Returns the ordered symbols, never caller-provided ordinals.

Source

pub fn ledger(&self) -> &AggregateLedger<A::Symbol>

Returns construction evidence for membership and aggregate counts.

Source

pub fn permutation_rank(&self) -> Result<Nat, SeriesError>

Returns the shared Lehmer rank when the series is exactly one permutation.

This method delegates to PermutationSpace and does not enumerate any permutations in this crate.

Source

pub fn into_parts(self) -> (A, AggregateRule, Vec<A::Symbol>)

Consumes the series into its validated parts.

Source§

impl<A: SerialAlphabet> Series<A>

Source

pub fn apply( &self, operation: &SeriesTransform<A>, ) -> Result<TransformedSeries<A>, SeriesTransformError>

Applies a validated transform and returns a valid series plus algebra evidence.

Trait Implementations§

Source§

impl<A: Clone + SerialAlphabet> Clone for Series<A>
where A::Symbol: Clone,

Source§

fn clone(&self) -> Series<A>

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<A: Debug + SerialAlphabet> Debug for Series<A>
where A::Symbol: Debug,

Source§

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

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

impl<A: Eq + SerialAlphabet> Eq for Series<A>
where A::Symbol: Eq,

Source§

impl<A: PartialEq + SerialAlphabet> PartialEq for Series<A>
where A::Symbol: PartialEq,

Source§

fn eq(&self, other: &Series<A>) -> bool

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

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

Inequality operator !=. Read more
Source§

impl<A: PartialEq + SerialAlphabet> StructuralPartialEq for Series<A>
where A::Symbol: PartialEq,

Auto Trait Implementations§

§

impl<A> Freeze for Series<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for Series<A>

§

impl<A> Send for Series<A>
where A: Send, <A as SerialAlphabet>::Symbol: Send,

§

impl<A> Sync for Series<A>
where A: Sync, <A as SerialAlphabet>::Symbol: Sync,

§

impl<A> Unpin for Series<A>
where A: Unpin, <A as SerialAlphabet>::Symbol: Unpin,

§

impl<A> UnsafeUnpin for Series<A>
where A: UnsafeUnpin,

§

impl<A> UnwindSafe for Series<A>

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 = Infallible

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

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

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.