@libraz/libcantus 0.9.4 → 1.0.0

package/dist/index-DInQqT8Q.d.cts

@@ -0,0 +1,66 @@
+/**
+ * Counterpoint classification of a harmonic interval by consonance.
+ *
+ * Distinct from a spelled interval's quality label — see
+ * {@link IntervalQualityLabel}, which names the `'P'` / `'M'` / `'m'` / `'A'` /
+ * `'d'` spelling of an interval rather than how it sounds against another
+ * voice.
+ *
+ * @see {@link IntervalQualityLabel}
+ * @category Pitch & Intervals
+ */
+declare enum ConsonanceClass {
+    PerfectConsonance = 0,
+    ImperfectConsonance = 1,
+    Dissonance = 2
+}
+/**
+ * Classify an interval for counterpoint evaluation.
+ *
+ * The interval is reduced modulo 12, so compound intervals classify as their
+ * simple equivalents. The perfect fourth (5) is context-dependent: with
+ * `twoVoice` (the default) it classifies as a dissonance, matching
+ * {@link isConsonantInterval}; otherwise it is an imperfect consonance.
+ *
+ * @param semitones Interval size in semitones (may be negative or compound).
+ * @param twoVoice When true, the perfect fourth is treated as dissonant.
+ * @returns The counterpoint quality of the interval.
+ * @example
+ * ```ts
+ * import { classifyInterval, ConsonanceClass } from '@libraz/libcantus';
+ * classifyInterval(7); // ConsonanceClass.PerfectConsonance
+ * classifyInterval(5); // ConsonanceClass.Dissonance (two-voice)
+ * classifyInterval(5, false); // ConsonanceClass.ImperfectConsonance
+ * ```
+ * @category Pitch & Intervals
+ */
+declare function classifyInterval(semitones: number, twoVoice?: boolean): ConsonanceClass;
+/**
+ * Test whether an interval is a perfect consonance: the unison/octave or the
+ * fifth.
+ *
+ * The perfect fourth is deliberately excluded. This is the predicate the
+ * parallel-motion rules are written against, where the fourth behaves as a
+ * dissonance between two voices; {@link classifyInterval} is the general
+ * classifier, and it treats the fourth as context-dependent.
+ *
+ * @param semitones Interval size in semitones (may be negative or compound).
+ * @returns True for the unison/octave (0) and the perfect fifth (7) mod 12.
+ * @category Pitch & Intervals
+ */
+declare function isPerfectInterval(semitones: number): boolean;
+/**
+ * Test whether an interval is consonant.
+ *
+ * The consonant set is {0, 3, 4, 5, 7, 8, 9} mod 12. In two-voice counterpoint
+ * the perfect fourth (5) is treated as a dissonance, so `twoVoice` set to true
+ * excludes it.
+ *
+ * @param semitones Interval size in semitones (may be negative or compound).
+ * @param twoVoice When true, the perfect fourth is treated as dissonant.
+ * @returns True if the interval is consonant in the given context.
+ * @category Pitch & Intervals
+ */
+declare function isConsonantInterval(semitones: number, twoVoice?: boolean): boolean;
+
+export { ConsonanceClass as C, isPerfectInterval as a, classifyInterval as c, isConsonantInterval as i };

package/dist/index-DInQqT8Q.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Counterpoint classification of a harmonic interval by consonance.
+ *
+ * Distinct from a spelled interval's quality label — see
+ * {@link IntervalQualityLabel}, which names the `'P'` / `'M'` / `'m'` / `'A'` /
+ * `'d'` spelling of an interval rather than how it sounds against another
+ * voice.
+ *
+ * @see {@link IntervalQualityLabel}
+ * @category Pitch & Intervals
+ */
+declare enum ConsonanceClass {
+    PerfectConsonance = 0,
+    ImperfectConsonance = 1,
+    Dissonance = 2
+}
+/**
+ * Classify an interval for counterpoint evaluation.
+ *
+ * The interval is reduced modulo 12, so compound intervals classify as their
+ * simple equivalents. The perfect fourth (5) is context-dependent: with
+ * `twoVoice` (the default) it classifies as a dissonance, matching
+ * {@link isConsonantInterval}; otherwise it is an imperfect consonance.
+ *
+ * @param semitones Interval size in semitones (may be negative or compound).
+ * @param twoVoice When true, the perfect fourth is treated as dissonant.
+ * @returns The counterpoint quality of the interval.
+ * @example
+ * ```ts
+ * import { classifyInterval, ConsonanceClass } from '@libraz/libcantus';
+ * classifyInterval(7); // ConsonanceClass.PerfectConsonance
+ * classifyInterval(5); // ConsonanceClass.Dissonance (two-voice)
+ * classifyInterval(5, false); // ConsonanceClass.ImperfectConsonance
+ * ```
+ * @category Pitch & Intervals
+ */
+declare function classifyInterval(semitones: number, twoVoice?: boolean): ConsonanceClass;
+/**
+ * Test whether an interval is a perfect consonance: the unison/octave or the
+ * fifth.
+ *
+ * The perfect fourth is deliberately excluded. This is the predicate the
+ * parallel-motion rules are written against, where the fourth behaves as a
+ * dissonance between two voices; {@link classifyInterval} is the general
+ * classifier, and it treats the fourth as context-dependent.
+ *
+ * @param semitones Interval size in semitones (may be negative or compound).
+ * @returns True for the unison/octave (0) and the perfect fifth (7) mod 12.
+ * @category Pitch & Intervals
+ */
+declare function isPerfectInterval(semitones: number): boolean;
+/**
+ * Test whether an interval is consonant.
+ *
+ * The consonant set is {0, 3, 4, 5, 7, 8, 9} mod 12. In two-voice counterpoint
+ * the perfect fourth (5) is treated as a dissonance, so `twoVoice` set to true
+ * excludes it.
+ *
+ * @param semitones Interval size in semitones (may be negative or compound).
+ * @param twoVoice When true, the perfect fourth is treated as dissonant.
+ * @returns True if the interval is consonant in the given context.
+ * @category Pitch & Intervals
+ */
+declare function isConsonantInterval(semitones: number, twoVoice?: boolean): boolean;
+
+export { ConsonanceClass as C, isPerfectInterval as a, classifyInterval as c, isConsonantInterval as i };