Struct subset::unique::Subset

pub struct Subset<'a, T> { /* fields omitted */ }

Subset of slice's items that is able to iterate forward and backward over immutable references to selected items. Each item of a slice can be selected no more than once.

Methods

impl<'a, T> Subset<'a, T>

pub fn new(set: &'a [T], idxs: &'a [usize]) -> Result<Self, SubsetError>

Constructs a subset from the whole set and indexes of the selected items. Both the uniqueness of the selected items and the array bounds is checked. Note that subsets are not designed for ZSTs.

Examples

let set = [1.0, 1.1, 1.2];
let idxs = [0, 1];
let subset = Subset::new(&set, &idxs).unwrap();

Errors

NotUnique, if there are duplicate indexes. OutOfBounds, if any index is >= set.len().

Panics

Panics if std::mem::size_of::<T>() == 0

pub unsafe fn new_unchecked(set: &'a [T], idxs: &'a [usize]) -> Self

Constructs a subset from the whole set and indexes of the selected items. Neither the uniqueness of the selected items, nor the array bounds is checked.

pub fn set(&self) -> &[T]

Returns the original slice.

pub fn idxs(&self) -> &[usize]

Returns indexes of selected items.

Important traits for Iter<'a, T>

impl<'a, T: 'a> Iterator for Iter<'a, T> type Item = &'a T;

pub fn iter(&self) -> Iter<T>

Returns an iterator over immutable references to selected items.

Trait Implementations

impl<'a, T> IntoIterator for &'a Subset<'a, T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

Important traits for Iter<'a, T>

impl<'a, T: 'a> Iterator for Iter<'a, T> type Item = &'a T;

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> From<SubsetMut<'a, T>> for Subset<'a, T>

fn from(s: SubsetMut<'a, T>) -> Self

Performs the conversion.

impl<'a, T> From<Subset<'a, T>> for Subset<'a, T>

fn from(s: Subset<T>) -> Subset<T>

Performs the conversion.

impl<'a, T: Debug> Debug for Subset<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> TryFrom<Subset<'a, T>> for Subset<'a, T>

type Error = SubsetError

The type returned in the event of a conversion error.

fn try_from(s: Subset<'a, T>) -> Result<Self, SubsetError>

Performs the conversion.

impl<'a, T> TryFrom<SubsetMut<'a, T>> for Subset<'a, T>

type Error = SubsetError

The type returned in the event of a conversion error.

fn try_from(s: SubsetMut<'a, T>) -> Result<Self, SubsetError>

Performs the conversion.