Struct Sieve

pub struct Sieve { /* private fields */ }

The representation of a Xenakis Sieve, constructed from a string notation of one or more Residual classes combined with logical operators. This Rust implementation follows the Python implementation in Ariza (2005), with significant performance and interface enhancements: https://direct.mit.edu/comj/article/29/2/40/93957

Implementations

impl Sieve

pub fn new(value: &str) -> Self

Construct a Xenakis Sieve from a string representation.

let s = xensieve::Sieve::new("3@0|5@1");
assert_eq!(s.iter_value(0..15).collect::<Vec<_>>(), vec![0, 1, 3, 6, 9, 11, 12])

pub fn contains(&self, value: i128) -> bool

Return true if the value is contained with this Sieve.

let s = xensieve::Sieve::new("3@0 & 5@0");
assert_eq!(s.contains(15), true);
assert_eq!(s.contains(16), false);
assert_eq!(s.contains(30), true);

pub fn iter_value( &self, iterator: impl Iterator<Item = i128>, ) -> IterValue<impl Iterator<Item = i128>>

For the iterator provided as an input, iterate the subset of values that are contained within the sieve.

let s = xensieve::Sieve::new("3@0|4@0");
assert_eq!(s.iter_value(0..=12).collect::<Vec<_>>(), vec![0, 3, 4, 6, 8, 9, 12])

pub fn iter_state( &self, iterator: impl Iterator<Item = i128>, ) -> IterState<impl Iterator<Item = i128>>

For the iterator provided as an input, iterate the Boolean status of contained.

let s = xensieve::Sieve::new("3@0|4@0");
assert_eq!(s.iter_state(0..=6).collect::<Vec<_>>(), vec![true, false, false, true, true, false, true])

pub fn iter_interval( &self, iterator: impl Iterator<Item = i128>, ) -> IterInterval<impl Iterator<Item = i128>>

Iterate over integer intervals between values in the sieve.

let s = xensieve::Sieve::new("3@0|4@0");
assert_eq!(s.iter_interval(0..=12).collect::<Vec<_>>(), vec![3, 1, 2, 2, 1, 3])

Trait Implementations

impl BitAnd for &Sieve

type Output = Sieve

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd for Sieve

type Output = Sieve

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for &Sieve

type Output = Sieve

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr for Sieve

type Output = Sieve

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for &Sieve

type Output = Sieve

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor for Sieve

type Output = Sieve

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for Sieve

fn clone(&self) -> Sieve

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sieve

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

Formats the value using the given formatter.

impl Display for Sieve

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

Formats the value using the given formatter.

impl Not for &Sieve

type Output = Sieve

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Not for Sieve

type Output = Sieve

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.