Struct analytic::set::ordered_integer_set::OrderedIntegerSet

pub struct OrderedIntegerSet<E: Integer + Copy + ToPrimitive> { /* fields omitted */ }

An OrderedIntegerSet consists of a sequence of ContiguousIntegerSet that are sorted in ascending order where successive intervals are not coalesceable, i.e. if intervals A and B are successive intervals, then A.end + 1 < B.start

E.g. An OrderedIntegerSet containing ContiguousIntegerSets [2,3] and [5,7] will represent the set of integers {2, 3, 5, 6, 7}

Methods

impl<E: Integer + Copy + ToPrimitive> OrderedIntegerSet<E>

pub fn new() -> OrderedIntegerSet<E>

pub fn first(&self) -> Option<E>

Returns the smallest element in the set e.g. {[1,3], [4,8]} -> 1

pub fn last(&self) -> Option<E>

Returns the largest element in the set e.g. {[1,3], [4,8]} -> 8

pub fn first_and_last(&self) -> Option<(E, E)>

Returns both the smallest and the largest element in the set e.g. {[1,3], [4,8]} -> the tuple (1, 8)

pub fn slice<'a, I: Slicing<&'a OrderedIntegerSet<E>, OrderedIntegerSet<E>>>(
    &'a self,
    slicer: I
) -> OrderedIntegerSet<E>

The slicer can be any struct that implements the Slicing trait. For example, the Slicing trait has been implemented for the Range<usize> struct.

For an OrderedIntegerSet containing n elements, the Range<usize> object created by a..b will slice the integer set and return all the elements from the a-th (inclusive) to the b-th (exclusive) in the form of an OrderedIntegerSet

pub fn from_slice(slice: &[[E; 2]]) -> OrderedIntegerSet<E>

Creates an OrderedIntegerSet where the i-th interval is represented by the i-th two-element array in slice.

E.g. [[2, 3], [5, 7]] will create an OrderedIntegerSet representing {2, 3, 5, 6, 7}, where the contiguous integers are stored as ContiguousIntegerSets

Note that the intervals in the slice parameters do not have to be sorted or non-overlapping.

pub fn from_contiguous_integer_sets(
    sets: Vec<ContiguousIntegerSet<E>>
) -> OrderedIntegerSet<E>

pub fn from_ordered_coalesced_contiguous_integer_sets(
    sets: Vec<ContiguousIntegerSet<E>>
) -> OrderedIntegerSet<E>

pub fn to_non_empty_intervals(&self) -> Self

pub fn into_non_empty_intervals(self) -> Self

pub fn remove_empty_intervals(&mut self)

pub fn get_intervals_by_ref(&self) -> &Vec<ContiguousIntegerSet<E>>

pub fn into_intervals(self) -> Vec<ContiguousIntegerSet<E>>

pub fn intervals_iter(&self) -> Iter<ContiguousIntegerSet<E>>

pub fn num_intervals(&self) -> usize

Trait Implementations

impl<E: Integer + Copy + ToPrimitive> CoalesceIntervals<ContiguousIntegerSet<E>, E> for OrderedIntegerSet<E>

fn to_coalesced_intervals(&self) -> Vec<ContiguousIntegerSet<E>>

fn coalesce_intervals_inplace(&mut self)

fn into_coalesced(self) -> Self

impl<'_, E: Integer + Copy + ToPrimitive> Sample<'_, ContiguousIntegerSetIter<E>, E, OrderedIntegerSet<E>> for ContiguousIntegerSet<E>

fn sample_subset_without_replacement<'s: 'a>(
    &'s self,
    size: usize
) -> Result<O, String>

samples size elements without replacement size: the number of samples to be drawn returns Err if size is larger than the population size

impl<'_, E: Integer + Copy + ToPrimitive + Sum> Sample<'_, IntegerSetIter<E>, E, OrderedIntegerSet<E>> for OrderedIntegerSet<E>

fn sample_subset_without_replacement<'s: 'a>(
    &'s self,
    size: usize
) -> Result<O, String>

samples size elements without replacement size: the number of samples to be drawn returns Err if size is larger than the population size

impl<'_, E: Integer + Copy + FromPrimitive + ToPrimitive + Debug> Slicing<&'_ OrderedIntegerSet<E>, OrderedIntegerSet<E>> for Range<usize>

fn slice(self, input: &OrderedIntegerSet<E>) -> OrderedIntegerSet<E>

the end index is exclusive

impl<E: Integer + Copy + ToPrimitive> Set<E, OrderedIntegerSet<E>> for OrderedIntegerSet<E>

fn is_empty(&self) -> bool

fn contains(&self, item: E) -> bool

fn intersect(&self, other: &OrderedIntegerSet<E>) -> OrderedIntegerSet<E>

impl<E: Integer + Copy + Sum + ToPrimitive> Finite for OrderedIntegerSet<E>

fn size(&self) -> usize

impl<E: Integer + Copy + ToPrimitive> Constructable for OrderedIntegerSet<E>

fn new() -> OrderedIntegerSet<E>

impl<E: Integer + Copy + ToPrimitive> Collecting<E> for OrderedIntegerSet<E>

fn collect(&mut self, item: E)

impl<'_, E: Integer + Copy + ToPrimitive> ToIterator<'_, IntegerSetIter<E>, E> for OrderedIntegerSet<E>

Important traits for IntegerSetIter<E>

impl<E: Integer + Copy + ToPrimitive> Iterator for IntegerSetIter<E> type Item = E;

fn to_iter(&self) -> IntegerSetIter<E>

impl<E: Integer + Copy + ToPrimitive> From<Vec<ContiguousIntegerSet<E>>> for OrderedIntegerSet<E>

fn from(intervals: Vec<ContiguousIntegerSet<E>>) -> OrderedIntegerSet<E>

Performs the conversion.

impl<E: Integer + Copy + ToPrimitive> From<OrderedIntegerSet<E>> for IntegerSetIter<E>

Important traits for IntegerSetIter<E>

impl<E: Integer + Copy + ToPrimitive> Iterator for IntegerSetIter<E> type Item = E;

fn from(ordered_integer_set: OrderedIntegerSet<E>) -> IntegerSetIter<E>

Performs the conversion.

impl<E: Clone + Integer + Copy + ToPrimitive> Clone for OrderedIntegerSet<E>

fn clone(&self) -> OrderedIntegerSet<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: PartialEq + Integer + Copy + ToPrimitive> PartialEq<OrderedIntegerSet<E>> for OrderedIntegerSet<E>

fn eq(&self, other: &OrderedIntegerSet<E>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OrderedIntegerSet<E>) -> bool

This method tests for !=.

impl<E: Debug + Integer + Copy + ToPrimitive> Debug for OrderedIntegerSet<E>

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

Formats the value using the given formatter.

impl<'_, E: Integer + Copy + ToPrimitive> Sub<&'_ ContiguousIntegerSet<E>> for OrderedIntegerSet<E>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: &ContiguousIntegerSet<E>) -> Self::Output

Performs the - operation.

impl<E: Integer + Copy + ToPrimitive> Sub<ContiguousIntegerSet<E>> for OrderedIntegerSet<E>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: ContiguousIntegerSet<E>) -> Self::Output

Performs the - operation.

impl<'_, E: Integer + Copy + ToPrimitive> Sub<&'_ OrderedIntegerSet<E>> for ContiguousIntegerSet<E>

type Output = OrderedIntegerSet<E>

The resulting type after applying the - operator.

fn sub(self, rhs: &OrderedIntegerSet<E>) -> Self::Output

Performs the - operation.

impl<E: Integer + Copy + ToPrimitive> Sub<OrderedIntegerSet<E>> for ContiguousIntegerSet<E>

type Output = OrderedIntegerSet<E>

The resulting type after applying the - operator.

fn sub(self, rhs: OrderedIntegerSet<E>) -> Self::Output

Performs the - operation.

impl<'_, E: Integer + Copy + ToPrimitive> Sub<&'_ OrderedIntegerSet<E>> for OrderedIntegerSet<E>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: &OrderedIntegerSet<E>) -> Self::Output

Performs the - operation.

impl<E: Integer + Copy + ToPrimitive> Sub<OrderedIntegerSet<E>> for OrderedIntegerSet<E>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: OrderedIntegerSet<E>) -> Self::Output

Performs the - operation.

impl<'_, E: Integer + Copy + ToPrimitive> SubAssign<&'_ ContiguousIntegerSet<E>> for OrderedIntegerSet<E>

fn sub_assign(&mut self, rhs: &ContiguousIntegerSet<E>)

Performs the -= operation.

impl<E: Integer + Copy + ToPrimitive> SubAssign<ContiguousIntegerSet<E>> for OrderedIntegerSet<E>

fn sub_assign(&mut self, rhs: ContiguousIntegerSet<E>)

Performs the -= operation.

impl<'_, E: Integer + Copy + ToPrimitive> SubAssign<&'_ OrderedIntegerSet<E>> for OrderedIntegerSet<E>

fn sub_assign(&mut self, rhs: &OrderedIntegerSet<E>)

Performs the -= operation.

impl<E: Integer + Copy + ToPrimitive> SubAssign<OrderedIntegerSet<E>> for OrderedIntegerSet<E>

fn sub_assign(&mut self, rhs: OrderedIntegerSet<E>)

Performs the -= operation.