PitchSpellingModifier

public protocol PitchSpellingModifier : Comparable, CustomStringConvertible, Hashable

Interface for types which modify a LetterName value. Graphically repesented as components of an Accidental.

Instance Properties

  • A PitchSpellingModifier which does not apply any modification.

    Declaration

    Swift

    static var identity: Self { get }

  • The amount that a PitchSpellingModifier modifies the base Pitch.Class of a LetterName (in percentage of a NoteNumber).

    Declaration

    Swift

    var adjustment: Double { get }

Equatable
  • ==(_:_:) Extension method

    Declaration

    Swift

    public static func == (lhs: Self, rhs: Self) -> Bool

    Return Value

    true if the adjustment property of the lhs value is equal to the adjustment property of the rhs value. Otherwise false.

Hashable
  • hashValue Extension method

    Declaration

    Swift

    public var hashValue: Int { get }

    Return Value

    The hashValue of the adjustment property.

Comparable
  • <(_:_:) Extension method

    Declaration

    Swift

    public static func < (lhs: Self, rhs: Self) -> Bool

    Return Value

    true if the adjustment property of the lhs value is less than the adjustment property of the rhs value. Otherwise false.