feat(intervals): add isDissonant getter (#43)

albertms10 · Apr 11, 2023 · 637bd58 · 637bd58
1 parent 63a0b59
commit 637bd58
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/lib/src/interval/intervals.dart b/lib/src/interval/intervals.dart
@@ -124,6 +124,18 @@ enum Intervals {
   /// ```
   bool get isCompound => ordinal > Intervals.octave.ordinal;
 
+  /// Whether this [Intervals] enum item is dissonant.
+  ///
+  /// Examples:
+  /// ```dart
+  /// Intervals.unison.isDissonant == false
+  /// Intervals.fifth.isDissonant == false
+  /// Intervals.seventh.isDissonant == true
+  /// Intervals.ninth.isDissonant == true
+  /// ```
+  bool get isDissonant =>
+      {Intervals.second, Intervals.seventh}.contains(simplified);
+
   /// Returns a simplified this [Intervals] enum item.
   ///
   /// Examples:

diff --git a/test/src/interval/intervals_test.dart b/test/src/interval/intervals_test.dart
@@ -61,6 +61,25 @@ void main() {
       });
     });
 
+    group('.isDissonant', () {
+      test('should return whether this Intervals enum item is dissonant', () {
+        expect(Intervals.unison.isDissonant, isFalse);
+        expect(Intervals.second.isDissonant, isTrue);
+        expect(Intervals.third.isDissonant, isFalse);
+        expect(Intervals.fourth.isDissonant, isFalse);
+        expect(Intervals.fifth.isDissonant, isFalse);
+        expect(Intervals.sixth.isDissonant, isFalse);
+        expect(Intervals.seventh.isDissonant, isTrue);
+        expect(Intervals.octave.isDissonant, isFalse);
+        expect(Intervals.ninth.isDissonant, isTrue);
+        expect(Intervals.tenth.isDissonant, isFalse);
+        expect(Intervals.eleventh.isDissonant, isFalse);
+        expect(Intervals.twelfth.isDissonant, isFalse);
+        expect(Intervals.thirteenth.isDissonant, isFalse);
+        expect(Intervals.fourteenth.isDissonant, isTrue);
+      });
+    });
+
     group('.simplified', () {
       test('should return the simplified Intervals enum item', () {
         expect(Intervals.second.simplified, Intervals.second);