Skip to main content

StreamAligner

Struct StreamAligner 

Source
pub struct StreamAligner {
    pub hasher: Hasher,
    pub hashed_target: Vec<NoteHash>,
    pub hashed_source: Vec<NoteHash>,
    pub distance_matrix: Vec<Vec<i64>>,
    pub changes: Vec<Change>,
    pub similarity_score: FloatType,
}
Expand description

Two streams aligned by their notes’ hashes, the cheapest edit from one to the other: music21’s StreamAligner.

Inserting or deleting a note costs as many as the values in its hash, and changing one as many values as differ.

Fields§

§hasher: Hasher

How notes are hashed: by default by MIDI pitch and rounded length, each with what it was made from.

§hashed_target: Vec<NoteHash>

The target’s hashes.

§hashed_source: Vec<NoteHash>

The source’s hashes.

§distance_matrix: Vec<Vec<i64>>

The cost of the cheapest edit from each opening of the target to each of the source.

§changes: Vec<Change>

The changes, in order.

§similarity_score: FloatType

The share of the changes that change nothing.

Implementations§

Source§

impl StreamAligner

Source

pub fn new() -> Self

An aligner with music21’s default hasher: pitch and length, each hash with what it was made from.

Source

pub fn with_hasher(hasher: Hasher) -> Self

An aligner hashing notes as this hasher does.

Source

pub fn align(&mut self, target: &Stream, source: &Stream) -> Result<()>

Aligns two streams: music21’s align.

§Errors

A stream with nothing to hash, or a hash the hasher refuses.

Source

pub fn align_hashed( &mut self, target: Vec<NoteHash>, source: Vec<NoteHash>, ) -> Result<()>

Aligns two lists of hashes already made: music21’s align with preHashed.

§Errors

An empty list.

Source

pub fn changes_count(&self, op: ChangeOp) -> usize

How many changes of each kind there are: music21’s changesCount.

Trait Implementations§

Source§

impl Clone for StreamAligner

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamAligner

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StreamAligner

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.