Struct libatm::midi_note::MIDINoteSet

pub struct MIDINoteSet(pub BTreeSet<MIDINote>);

Container for set of MIDINote

Implements the FromStr trait as a convenience method for parsing a set of MIDINote (from a command line argument).

Examples

// Parse MIDI note set from &str
let note_set = "C:4,D:5,CSharp:8,DSharp:3".parse::<libatm::MIDINoteSet>().unwrap();
// Expected note set contains C:4, D:5, CSharp:8, and DSharp:3
let expected = libatm::MIDINoteSet(vec![
    libatm::MIDINote::new(libatm::MIDINoteType::C, 4),
    libatm::MIDINote::new(libatm::MIDINoteType::D, 5),
    libatm::MIDINote::new(libatm::MIDINoteType::CSharp, 8),
    libatm::MIDINote::new(libatm::MIDINoteType::DSharp, 3),
].into_iter().collect::<std::collections::BTreeSet<libatm::MIDINote>>());
assert_eq!(expected, note_set);

Methods from Deref<Target = BTreeSet<MIDINote>>

pub fn range<K, R>(&self, range: R) -> Range<T> where
    K: Ord + ?Sized,
    R: RangeBounds<K>,
    T: Borrow<K>, 

Constructs a double-ended iterator over a sub-range of elements in the set. The simplest way is to use the range syntax min..max, thus range(min..max) will yield elements from min (inclusive) to max (exclusive). The range may also be entered as (Bound<T>, Bound<T>), so for example range((Excluded(4), Included(10))) will yield a left-exclusive, right-inclusive range from 4 to 10.

Examples

use std::collections::BTreeSet;
use std::ops::Bound::Included;

let mut set = BTreeSet::new();
set.insert(3);
set.insert(5);
set.insert(8);
for &elem in set.range((Included(&4), Included(&8))) {
    println!("{}", elem);
}
assert_eq!(Some(&5), set.range(4..).next());

pub fn difference(&'a self, other: &'a BTreeSet<T>) -> Difference<'a, T>

Visits the values representing the difference, i.e., the values that are in self but not in other, in ascending order.

Examples

use std::collections::BTreeSet;

let mut a = BTreeSet::new();
a.insert(1);
a.insert(2);

let mut b = BTreeSet::new();
b.insert(2);
b.insert(3);

let diff: Vec<_> = a.difference(&b).cloned().collect();
assert_eq!(diff, [1]);

pub fn symmetric_difference(
    &'a self,
    other: &'a BTreeSet<T>
) -> SymmetricDifference<'a, T>

Visits the values representing the symmetric difference, i.e., the values that are in self or in other but not in both, in ascending order.

Examples

use std::collections::BTreeSet;

let mut a = BTreeSet::new();
a.insert(1);
a.insert(2);

let mut b = BTreeSet::new();
b.insert(2);
b.insert(3);

let sym_diff: Vec<_> = a.symmetric_difference(&b).cloned().collect();
assert_eq!(sym_diff, [1, 3]);

pub fn intersection(&'a self, other: &'a BTreeSet<T>) -> Intersection<'a, T>

Visits the values representing the intersection, i.e., the values that are both in self and other, in ascending order.

Examples

use std::collections::BTreeSet;

let mut a = BTreeSet::new();
a.insert(1);
a.insert(2);

let mut b = BTreeSet::new();
b.insert(2);
b.insert(3);

let intersection: Vec<_> = a.intersection(&b).cloned().collect();
assert_eq!(intersection, [2]);

pub fn union(&'a self, other: &'a BTreeSet<T>) -> Union<'a, T>

Visits the values representing the union, i.e., all the values in self or other, without duplicates, in ascending order.

Examples

use std::collections::BTreeSet;

let mut a = BTreeSet::new();
a.insert(1);

let mut b = BTreeSet::new();
b.insert(2);

let union: Vec<_> = a.union(&b).cloned().collect();
assert_eq!(union, [1, 2]);

pub fn contains<Q>(&self, value: &Q) -> bool where
    Q: Ord + ?Sized,
    T: Borrow<Q>, 

Returns true if the set contains a value.

The value may be any borrowed form of the set's value type, but the ordering on the borrowed form must match the ordering on the value type.

Examples

use std::collections::BTreeSet;

let set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
assert_eq!(set.contains(&1), true);
assert_eq!(set.contains(&4), false);

pub fn get<Q>(&self, value: &Q) -> Option<&T> where
    Q: Ord + ?Sized,
    T: Borrow<Q>, 

Returns a reference to the value in the set, if any, that is equal to the given value.

The value may be any borrowed form of the set's value type, but the ordering on the borrowed form must match the ordering on the value type.

Examples

use std::collections::BTreeSet;

let set: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
assert_eq!(set.get(&2), Some(&2));
assert_eq!(set.get(&4), None);

pub fn is_disjoint(&self, other: &BTreeSet<T>) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

Examples

use std::collections::BTreeSet;

let a: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
let mut b = BTreeSet::new();

assert_eq!(a.is_disjoint(&b), true);
b.insert(4);
assert_eq!(a.is_disjoint(&b), true);
b.insert(1);
assert_eq!(a.is_disjoint(&b), false);

pub fn is_subset(&self, other: &BTreeSet<T>) -> bool

Returns true if the set is a subset of another, i.e., other contains at least all the values in self.

Examples

use std::collections::BTreeSet;

let sup: BTreeSet<_> = [1, 2, 3].iter().cloned().collect();
let mut set = BTreeSet::new();

assert_eq!(set.is_subset(&sup), true);
set.insert(2);
assert_eq!(set.is_subset(&sup), true);
set.insert(4);
assert_eq!(set.is_subset(&sup), false);

pub fn is_superset(&self, other: &BTreeSet<T>) -> bool

Returns true if the set is a superset of another, i.e., self contains at least all the values in other.

Examples

use std::collections::BTreeSet;

let sub: BTreeSet<_> = [1, 2].iter().cloned().collect();
let mut set = BTreeSet::new();

assert_eq!(set.is_superset(&sub), false);

set.insert(0);
set.insert(1);
assert_eq!(set.is_superset(&sub), false);

set.insert(2);
assert_eq!(set.is_superset(&sub), true);

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

🔬 This is a nightly-only experimental API. (map_first_last)

Returns a reference to the first value in the set, if any. This value is always the minimum of all values in the set.

Examples

Basic usage:

#![feature(map_first_last)]
use std::collections::BTreeSet;

let mut map = BTreeSet::new();
assert_eq!(map.first(), None);
map.insert(1);
assert_eq!(map.first(), Some(&1));
map.insert(2);
assert_eq!(map.first(), Some(&1));

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

🔬 This is a nightly-only experimental API. (map_first_last)

Returns a reference to the last value in the set, if any. This value is always the maximum of all values in the set.

Examples

Basic usage:

#![feature(map_first_last)]
use std::collections::BTreeSet;

let mut map = BTreeSet::new();
assert_eq!(map.first(), None);
map.insert(1);
assert_eq!(map.last(), Some(&1));
map.insert(2);
assert_eq!(map.last(), Some(&2));

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

Gets an iterator that visits the values in the BTreeSet in ascending order.

Examples

use std::collections::BTreeSet;

let set: BTreeSet<usize> = [1, 2, 3].iter().cloned().collect();
let mut set_iter = set.iter();
assert_eq!(set_iter.next(), Some(&1));
assert_eq!(set_iter.next(), Some(&2));
assert_eq!(set_iter.next(), Some(&3));
assert_eq!(set_iter.next(), None);

Values returned by the iterator are returned in ascending order:

use std::collections::BTreeSet;

let set: BTreeSet<usize> = [3, 1, 2].iter().cloned().collect();
let mut set_iter = set.iter();
assert_eq!(set_iter.next(), Some(&1));
assert_eq!(set_iter.next(), Some(&2));
assert_eq!(set_iter.next(), Some(&3));
assert_eq!(set_iter.next(), None);

pub fn len(&self) -> usize

Returns the number of elements in the set.

Examples

use std::collections::BTreeSet;

let mut v = BTreeSet::new();
assert_eq!(v.len(), 0);
v.insert(1);
assert_eq!(v.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

Examples

use std::collections::BTreeSet;

let mut v = BTreeSet::new();
assert!(v.is_empty());
v.insert(1);
assert!(!v.is_empty());

Trait Implementations

impl Clone for MIDINoteSet

fn clone(&self) -> MIDINoteSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MIDINoteSet

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

Formats the value using the given formatter.

impl Deref for MIDINoteSet

type Target = BTreeSet<MIDINote>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Allow dereferencing of tuple struct to underlying hash set

impl<'_> From<&'_ MIDINoteSet> for MIDINoteVec

fn from(set: &MIDINoteSet) -> Self

Performs the conversion.

impl From<MIDINoteSet> for MIDINoteVec

fn from(set: MIDINoteSet) -> Self

Performs the conversion.

impl FromStr for MIDINoteSet

type Err = ParseMIDINoteSequenceError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Credit to @ldesgoui for the implementation

impl PartialEq<MIDINoteSet> for MIDINoteSet

fn eq(&self, other: &MIDINoteSet) -> bool

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

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

This method tests for !=.

impl StructuralPartialEq for MIDINoteSet