Struct bellframe::mask::Mask

pub struct Mask { /* private fields */ }

A mask which fixes the location of some Bells. Unfilled positions are usually denoted by 'x' (X is not a valid Bell name).

This can also be thought of as a music Pattern with no *s.

Implementations

impl Mask

pub fn parse(s: &str) -> Self

pub fn parse_with_stage(s: &str, stage: Stage) -> Result<Self, ParseError>

pub fn from_pattern(pattern: &Pattern) -> Result<Self, MultipleStars>

Convert a Pattern into a Mask of the same Stage, expanding at most one * if it exists.

pub fn full_row(row: &Row) -> Self

Creates a Mask that fully specifies a given Row

pub fn empty(stage: Stage) -> Self

Creates a Mask that matches any Row of a given Stage (i.e. a mask where no Bell is fixed, written as xxxx...).

pub fn fix_bells(
    stage: Stage,
    fixed_bells: impl IntoIterator<Item = Bell>
) -> Self

Creates a Mask that fixes the given Bells into their corresponding ‘home’ place.

Panics

Panics if any of the Bell are outside the Stage of this Mask.

pub fn fix(&mut self, b: Bell) -> Result<(), BellAlreadySet>

Modifies self so that a Bell is fixed in its home position. Returns Err(()) if that Bell already appears in this Mask.

pub unsafe fn fix_unchecked(&mut self, b: Bell)

Modifies self so that a Bell is fixed in its home position, without checking if that Bell is already fixed in a different location.

Panics

Panics if the Bell is outside the Stage of this Mask.

Safety

This function is safe if b is not already fixed in self, or is already fixed to its home position.

pub fn unspecified_places(&self) -> impl Iterator<Item = usize> + '_

Returns an Iterator over the indices of locations where this Mask contains an x

pub fn stage(&self) -> Stage

Returns the Stage of Row that this Mask matches

pub fn matches(&self, row: &Row) -> bool

Tests whether or not a Row satisfies this Mask.

pub fn place_of(&self, bell: Bell) -> Option<usize>

Returns the place of a Bell within this Mask. If that Bell isn’t found (either because it’s outside the Stage or because the Mask doesn’t specify a location) this returns None.

pub fn set_bell(&mut self, bell: Bell, place: usize) -> Result<(), BellAlreadySet>

Updates this Mask so that a given Bell is required at a given place.

pub unsafe fn set_bell_unchecked(&mut self, bell: Bell, place: usize)

Updates this Mask so that a given Bell is required at a given place.

Safety

This function is safe if b is not already fixed in self, or is already fixed at the given place.

pub fn is_empty(&self) -> bool

pub fn as_row(&self) -> Option<RowBuf>

If this mask matches exactly one Row, then return that Row (otherwise None).

pub fn is_subset_of(&self, other: &Mask) -> bool

Returns true if the set of Rows satisfying self is a subset of those satisfying other. This implies that self is ‘stricter’ than other; for example, xx3456 is a subset of xxxx56.

pub fn is_strict_subset_of(&self, other: &Mask) -> bool

Returns true if the set of Rows satisfying self is a strict subset of those satisfying other.

pub fn is_compatible_with(&self, other: &Mask) -> bool

Check if there exist any Rows which can satisfy both Masks (i.e. the two Masks are ‘compatible’). a.is_compatible_with(b) equivalent to (but faster than) a.combine(b).is_some().

pub fn intersect(&self, other: &Mask) -> Option<Mask>

Creates a new Mask which matches precisely the Rows matched by both self and other. If self and other aren’t compatible, then such a Mask cannot exist and None is returned.

Trait Implementations

impl Clone for Mask

fn clone(&self) -> Mask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mask

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

Formats the value using the given formatter.

impl Display for Mask

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

Formats the value using the given formatter.

impl From<&Row> for Mask

fn from(r: &Row) -> Self

Converts to this type from the input type.

impl From<Mask> for Pattern

fn from(mask: Mask) -> Pattern

Converts to this type from the input type.

impl From<RowBuf> for Mask

fn from(r: RowBuf) -> Self

Converts to this type from the input type.

impl Hash for Mask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Mul<&Mask> for &Row

fn mul(self, rhs: &Mask) -> Self::Output

Use a Row to transfigure the required Bells in a Mask. Mathematically, if r is a Row and m is a Mask and m matches some Row s, then r * m matches r * s.

Panics

Panics if the Stages of the Row and Mask don’t match.

type Output = Mask

The resulting type after applying the * operator.

impl Mul<&Mask> for &RowBuf

fn mul(self, rhs: &Mask) -> Self::Output

Use a RowBuf to transfigure the required Bells in a Mask. Mathematically, if r is a RowBuf and m is a Mask and m matches some RowBuf s, then r * m matches r * s.

Panics

Panics if the Stages of the Row and Mask don’t match.

type Output = Mask

The resulting type after applying the * operator.

impl Mul<&Mask> for RowBuf

fn mul(self, rhs: &Mask) -> Self::Output

Use a RowBuf to transfigure the required Bells in a Mask. Mathematically, if r is a RowBuf and m is a Mask and m matches some RowBuf s, then r * m matches r * s.

Panics

Panics if the Stages of the Row and Mask don’t match.

type Output = Mask

The resulting type after applying the * operator.

impl Mul<&Row> for &Mask

fn mul(self, rhs: &Row) -> Self::Output

Use a Row to permute the required Bells in a Mask. Mathematically, if r is a Row and m is a Mask and m matches some Row s, then m * r matches s * r.

Panics

Panics if the Stages of the Row and Mask don’t match.

type Output = Mask

The resulting type after applying the * operator.

impl Mul<&RowBuf> for &Mask

fn mul(self, rhs: &RowBuf) -> Self::Output

Use a RowBuf to permute the required Bells in a Mask. Mathematically, if r is a RowBuf and m is a Mask and m matches some RowBuf s, then m * r matches s * r.

Panics

Panics if the Stages of the Row and Mask don’t match.

type Output = Mask

The resulting type after applying the * operator.

impl Mul<RowBuf> for &Mask

fn mul(self, rhs: RowBuf) -> Self::Output

Use a RowBuf to permute the required Bells in a Mask. Mathematically, if r is a RowBuf and m is a Mask and m matches some RowBuf s, then m * r matches s * r.

Panics

Panics if the Stages of the Row and Mask don’t match.

type Output = Mask

The resulting type after applying the * operator.

impl Ord for Mask

fn cmp(&self, other: &Mask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Mask> for Mask

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

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

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

This method tests for !=.

impl PartialOrd<Mask> for Mask

fn partial_cmp(&self, other: &Mask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Mask

impl StructuralEq for Mask

impl StructuralPartialEq for Mask