Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(note): add Tonality major and minor getters #124

Merged
merged 1 commit into from
May 14, 2023
Merged

feat(note): add Tonality major and minor getters #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions lib/src/note/note.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,24 @@ final class Note implements Comparable<Note>, Transposable<Note> {
/// ```
int difference(Note other) => other.semitones - semitones;

/// Returns the [TonalMode.major] [Tonality] from this [Note].
///
/// Example:
/// ```dart
/// Note.c.major == const Tonality(Note.c, TonalMode.major)
/// Note.eFlat.major == const Tonality(Note.eFlat, TonalMode.major)
/// ```
Tonality get major => Tonality(this, TonalMode.major);

/// Returns the [TonalMode.minor] [Tonality] from this [Note].
///
/// Example:
/// ```dart
/// Note.d.minor == const Tonality(Note.d, TonalMode.minor)
/// Note.gSharp.minor == const Tonality(Note.gSharp, TonalMode.minor)
/// ```
Tonality get minor => Tonality(this, TonalMode.minor);

/// Returns this [Note] positioned in the given [octave] as [PositionedNote].
///
/// Example:
Expand Down
8 changes: 4 additions & 4 deletions lib/src/tonality/key_signature.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ final class KeySignature implements Comparable<KeySignature> {
///
/// Example:
/// ```dart
/// const KeySignature(0).tonality(TonalMode.major) == Tonality.cMajor
/// const KeySignature(0).tonality(TonalMode.major) == Note.c.major
/// const KeySignature(2, Accidental.flat).tonality(TonalMode.minor)
/// == Tonality.gMinor
/// == Note.g.minor
/// ```
Tonality tonality(TonalMode mode) =>
Tonality.fromAccidentals(accidentals, mode, accidental);
Expand All @@ -73,8 +73,8 @@ final class KeySignature implements Comparable<KeySignature> {
/// Example:
/// ```dart
/// const KeySignature(2, Accidental.flat).tonalities == {
/// Tonality.bFlatMajor,
/// Tonality.gMinor,
/// Note.bFlat.major,
/// Note.g.minor,
/// }
/// ```
Set<Tonality> get tonalities =>
Expand Down
55 changes: 7 additions & 48 deletions lib/src/tonality/tonality.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,47 +7,6 @@ final class Tonality implements Comparable<Tonality> {

const Tonality(this.note, this.mode);

static const cMajor = Tonality(Note.c, TonalMode.major);
static const cMinor = Tonality(Note.c, TonalMode.minor);

static const cSharpMajor = Tonality(Note.cSharp, TonalMode.major);
static const cSharpMinor = Tonality(Note.cSharp, TonalMode.minor);
static const dFlatMajor = Tonality(Note.dFlat, TonalMode.major);

static const dMajor = Tonality(Note.d, TonalMode.major);
static const dMinor = Tonality(Note.d, TonalMode.minor);

static const dSharpMinor = Tonality(Note.dSharp, TonalMode.minor);
static const eFlatMajor = Tonality(Note.eFlat, TonalMode.major);
static const eFlatMinor = Tonality(Note.eFlat, TonalMode.minor);

static const eMajor = Tonality(Note.e, TonalMode.major);
static const eMinor = Tonality(Note.e, TonalMode.minor);

static const fMajor = Tonality(Note.f, TonalMode.major);
static const fMinor = Tonality(Note.f, TonalMode.minor);

static const fSharpMajor = Tonality(Note.fSharp, TonalMode.major);
static const fSharpMinor = Tonality(Note.fSharp, TonalMode.minor);
static const gFlatMajor = Tonality(Note.gFlat, TonalMode.major);

static const gMajor = Tonality(Note.g, TonalMode.major);
static const gMinor = Tonality(Note.g, TonalMode.minor);

static const gSharpMinor = Tonality(Note.gSharp, TonalMode.minor);
static const aFlatMajor = Tonality(Note.aFlat, TonalMode.major);
static const aFlatMinor = Tonality(Note.aFlat, TonalMode.minor);

static const aMajor = Tonality(Note.a, TonalMode.major);
static const aMinor = Tonality(Note.a, TonalMode.minor);

static const aSharpMinor = Tonality(Note.aSharp, TonalMode.minor);
static const bFlatMajor = Tonality(Note.bFlat, TonalMode.major);
static const bFlatMinor = Tonality(Note.bFlat, TonalMode.minor);

static const bMajor = Tonality(Note.b, TonalMode.major);
static const bMinor = Tonality(Note.b, TonalMode.minor);

factory Tonality.fromAccidentals(
int accidentals,
TonalMode mode, [
Expand All @@ -63,8 +22,8 @@ final class Tonality implements Comparable<Tonality> {
///
/// Example:
/// ```dart
/// Tonality.dMinor.relative == Tonality.fMajor
/// Tonality.bFlatMajor.relative == Tonality.gMinor
/// Note.d.minor.relative == Note.f.major
/// Note.bFlat.major.relative == Note.g.minor
/// ```
Tonality get relative => Tonality(
note.transposeBy(
Expand All @@ -77,9 +36,9 @@ final class Tonality implements Comparable<Tonality> {
///
/// Example:
/// ```dart
/// Tonality.cMajor.keySignature == const KeySignature(0)
/// Tonality.aMajor.keySignature == const KeySignature(3, Accidental.sharp)
/// Tonality.gFlatMajor.keySignature == const KeySignature(6, Accidental.flat)
/// Note.c.major.keySignature == const KeySignature(0)
/// Note.a.major.keySignature == const KeySignature(3, Accidental.sharp)
/// Note.gFlat.major.keySignature == const KeySignature(6, Accidental.flat)
/// ```
KeySignature get keySignature => KeySignature.fromDistance(
Tonality.fromAccidentals(0, mode).note.exactFifthsDistance(note),
Expand All @@ -89,11 +48,11 @@ final class Tonality implements Comparable<Tonality> {
///
/// Example:
/// ```dart
/// Tonality.cMajor.scaleNotes
/// Note.c.major.scaleNotes
/// == const [Note.c, Note.d, Note.e, Note.f, Note.g, Note.a, Note.b,
/// Note.c]
///
/// Tonality.eMinor.scaleNotes
/// Note.e.minor.scaleNotes
/// == const [Note.e, Note.fSharp, Note.g, Note.a, Note.b, Note.d, Note.d,
/// Note.e]
/// ```
Expand Down
78 changes: 39 additions & 39 deletions test/src/tonality/key_signature_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,43 +78,43 @@ void main() {
test('should return the Tonality from TonalMode', () {
expect(
const KeySignature(4, Accidental.flat).tonality(TonalMode.major),
Tonality.aFlatMajor,
Note.aFlat.major,
);
expect(
const KeySignature(4, Accidental.flat).tonality(TonalMode.minor),
Tonality.fMinor,
Note.f.minor,
);
expect(
const KeySignature(2, Accidental.flat).tonality(TonalMode.major),
Tonality.bFlatMajor,
Note.bFlat.major,
);
expect(
const KeySignature(2, Accidental.flat).tonality(TonalMode.minor),
Tonality.gMinor,
Note.g.minor,
);
expect(
const KeySignature(0).tonality(TonalMode.major),
Tonality.cMajor,
Note.c.major,
);
expect(
const KeySignature(0).tonality(TonalMode.minor),
Tonality.aMinor,
Note.a.minor,
);
expect(
const KeySignature(1, Accidental.sharp).tonality(TonalMode.major),
Tonality.gMajor,
Note.g.major,
);
expect(
const KeySignature(1, Accidental.sharp).tonality(TonalMode.minor),
Tonality.eMinor,
Note.e.minor,
);
expect(
const KeySignature(5, Accidental.sharp).tonality(TonalMode.major),
Tonality.bMajor,
Note.b.major,
);
expect(
const KeySignature(5, Accidental.sharp).tonality(TonalMode.minor),
Tonality.gSharpMinor,
Note.gSharp.minor,
);
});
});
Expand All @@ -141,63 +141,63 @@ void main() {
});
expect(const KeySignature(7, Accidental.flat).tonalities, {
const Tonality(Note(BaseNote.c, Accidental.flat), TonalMode.major),
Tonality.aFlatMinor,
Note.aFlat.minor,
});
expect(const KeySignature(6, Accidental.flat).tonalities, {
Tonality.gFlatMajor,
Tonality.eFlatMinor,
Note.gFlat.major,
Note.eFlat.minor,
});
expect(const KeySignature(5, Accidental.flat).tonalities, {
Tonality.dFlatMajor,
Tonality.bFlatMinor,
Note.dFlat.major,
Note.bFlat.minor,
});
expect(const KeySignature(4, Accidental.flat).tonalities, {
Tonality.aFlatMajor,
Tonality.fMinor,
Note.aFlat.major,
Note.f.minor,
});
expect(const KeySignature(3, Accidental.flat).tonalities, {
Tonality.eFlatMajor,
Tonality.cMinor,
Note.eFlat.major,
Note.c.minor,
});
expect(const KeySignature(2, Accidental.flat).tonalities, {
Tonality.bFlatMajor,
Tonality.gMinor,
Note.bFlat.major,
Note.g.minor,
});
expect(const KeySignature(1, Accidental.flat).tonalities, {
Tonality.fMajor,
Tonality.dMinor,
Note.f.major,
Note.d.minor,
});
expect(const KeySignature(0).tonalities, {
Tonality.cMajor,
Tonality.aMinor,
Note.c.major,
Note.a.minor,
});
expect(const KeySignature(1, Accidental.sharp).tonalities, {
Tonality.gMajor,
Tonality.eMinor,
Note.g.major,
Note.e.minor,
});
expect(const KeySignature(2, Accidental.sharp).tonalities, {
Tonality.dMajor,
Tonality.bMinor,
Note.d.major,
Note.b.minor,
});
expect(const KeySignature(3, Accidental.sharp).tonalities, {
Tonality.aMajor,
Tonality.fSharpMinor,
Note.a.major,
Note.fSharp.minor,
});
expect(const KeySignature(4, Accidental.sharp).tonalities, {
Tonality.eMajor,
Tonality.cSharpMinor,
Note.e.major,
Note.cSharp.minor,
});
expect(const KeySignature(5, Accidental.sharp).tonalities, {
Tonality.bMajor,
Tonality.gSharpMinor,
Note.b.major,
Note.gSharp.minor,
});
expect(const KeySignature(6, Accidental.sharp).tonalities, {
Tonality.fSharpMajor,
Tonality.dSharpMinor,
Note.fSharp.major,
Note.dSharp.minor,
});
expect(const KeySignature(7, Accidental.sharp).tonalities, {
Tonality.cSharpMajor,
Tonality.aSharpMinor,
Note.cSharp.major,
Note.aSharp.minor,
});
expect(const KeySignature(8, Accidental.sharp).tonalities, {
const Tonality(Note.gSharp, TonalMode.major),
Expand Down
Loading