diff --git a/README.md b/README.md index 71965714..a96c66c9 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,8 @@ void main() { // Frequencies Note.a.inOctave(4).equalTemperamentFrequency(); // 440.0 Hz Note.b.flat.inOctave(4).equalTemperamentFrequency( - reference: Note.c.inOctave(4), - frequency: const Frequency(256), + referenceNote: Note.c.inOctave(4), + referenceFrequency: const Frequency(256), ); // 456.1401436878537 Hz // Crazy chaining diff --git a/example/main.dart b/example/main.dart index 2c7bda77..4b997856 100644 --- a/example/main.dart +++ b/example/main.dart @@ -37,8 +37,8 @@ void main() { // Frequencies Note.a.inOctave(4).equalTemperamentFrequency(); // 440.0 Hz Note.b.flat.inOctave(4).equalTemperamentFrequency( - reference: Note.c.inOctave(4), - frequency: const Frequency(256), + referenceNote: Note.c.inOctave(4), + referenceFrequency: const Frequency(256), ); // 456.1401436878537 Hz // Crazy chaining diff --git a/lib/src/note/frequency.dart b/lib/src/note/frequency.dart index fd5390f1..3aed0f2d 100644 --- a/lib/src/note/frequency.dart +++ b/lib/src/note/frequency.dart @@ -28,8 +28,9 @@ class Frequency implements Comparable { return hertz >= minFrequency && hertz <= maxFrequency; } - /// Returns the closest [PositionedNote] to this [Frequency], with the - /// difference in `cents` and `hertz`. + /// Returns the closest [PositionedNote] to this [Frequency] from + /// [referenceNote] and [referenceFrequency], with the difference in `cents` + /// and `hertz`. /// /// Example: /// ```dart @@ -61,8 +62,8 @@ class Frequency implements Comparable { .inOctave(PositionedNote.octaveFromSemitones(semitones)); final closestNoteFrequency = closestNote.equalTemperamentFrequency( - reference: referenceNote, - frequency: referenceFrequency, + referenceNote: referenceNote, + referenceFrequency: referenceFrequency, ); return ( diff --git a/lib/src/note/positioned_note.dart b/lib/src/note/positioned_note.dart index 4690d294..0652ec53 100644 --- a/lib/src/note/positioned_note.dart +++ b/lib/src/note/positioned_note.dart @@ -236,7 +236,7 @@ final class PositionedNote } /// Returns the equal temperament [Frequency] of this [PositionedNote] from - /// [frequency] and [reference]. + /// [referenceNote] and [referenceFrequency]. /// /// Example: /// ```dart @@ -244,12 +244,12 @@ final class PositionedNote /// Note.c.inOctave(4).equalTemperamentFrequency() == const Frequency(261.63) /// /// Note.b.flat.inOctave(4).equalTemperamentFrequency( - /// frequency: const Frequency(438), + /// referenceFrequency: const Frequency(438), /// ) == const Frequency(464.04) /// /// Note.a.inOctave(4).equalTemperamentFrequency( - /// reference: Note.c.inOctave(4), - /// frequency: const Frequency(256), + /// referenceNote: Note.c.inOctave(4), + /// referenceFrequency: const Frequency(256), /// ) == const Frequency(430.54) /// ``` /// @@ -261,10 +261,11 @@ final class PositionedNote /// note.equalTemperamentFrequency().closestPositionedNote().$1 == note; /// ``` Frequency equalTemperamentFrequency({ - PositionedNote reference = const PositionedNote(Note.a, octave: 4), - Frequency frequency = const Frequency(440), + PositionedNote referenceNote = const PositionedNote(Note.a, octave: 4), + Frequency referenceFrequency = const Frequency(440), }) => - frequency * EqualTemperament.edo12.ratio(reference.difference(this)); + referenceFrequency * + EqualTemperament.edo12.ratio(referenceNote.difference(this)); /// Returns the string representation of this [Note] following the /// [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation). diff --git a/test/src/note/positioned_note_test.dart b/test/src/note/positioned_note_test.dart index 0587213e..bc64ed8e 100644 --- a/test/src/note/positioned_note_test.dart +++ b/test/src/note/positioned_note_test.dart @@ -733,119 +733,119 @@ void main() { expect( Note.c .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(260.44, 0.01), ); expect( Note.c.sharp .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(275.92, 0.01), ); expect( Note.d.flat .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(275.92, 0.01), ); expect( Note.d .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(292.33, 0.01), ); expect( Note.d.sharp .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(309.71, 0.01), ); expect( Note.e.flat .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(309.71, 0.01), ); expect( Note.e .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(328.13, 0.01), ); expect( Note.f .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(347.64, 0.01), ); expect( Note.f.sharp .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(368.31, 0.01), ); expect( Note.g.flat .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(368.31, 0.01), ); expect( Note.g .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(390.21, 0.01), ); expect( Note.g.sharp .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(413.42, 0.01), ); expect( Note.a.flat .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(413.42, 0.01), ); expect( Note.a .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, 438, ); expect( Note.a.sharp .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(464.04, 0.01), ); expect( Note.b.flat .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(464.04, 0.01), ); expect( Note.b .inOctave(4) - .equalTemperamentFrequency(frequency: frequency) + .equalTemperamentFrequency(referenceFrequency: frequency) .hertz, closeTo(491.64, 0.01), ); @@ -860,8 +860,8 @@ void main() { Note.c .inOctave(4) .equalTemperamentFrequency( - frequency: frequency, - reference: Note.c.inOctave(4), + referenceFrequency: frequency, + referenceNote: Note.c.inOctave(4), ) .hertz, 256, @@ -870,8 +870,8 @@ void main() { Note.a .inOctave(4) .equalTemperamentFrequency( - frequency: frequency, - reference: Note.c.inOctave(4), + referenceFrequency: frequency, + referenceNote: Note.c.inOctave(4), ) .hertz, closeTo(430.53, 0.01),