@libraz/libcantus 0.9.2 → 0.9.3

package/dist/core/index.d.cts

@@ -1,6 +1,33 @@
-export { B as BarPosition, T as TimeSignature, b as barPositionToBeat, a as beatToBarPosition, c as beatsPerBar, f as formatTimeSignature, i as isCompound, d as isStrongBeat, m as metricWeight, p as parseTimeSignature, e as pulsesPerBar, t as tuplet } from '../index-Cl7mhOFM.cjs';
+import { N as NoteEvent } from '../types-MGP29r3t.cjs';
+export { K as KeyScale } from '../types-MGP29r3t.cjs';
+import { T as TimeSignature } from '../index-Cl7mhOFM.cjs';
+export { B as BarPosition, b as barPositionToBeat, a as beatToBarPosition, c as beatsPerBar, f as formatTimeSignature, i as isCompound, d as isStrongBeat, m as metricWeight, p as parseTimeSignature, e as pulsesPerBar, t as tuplet } from '../index-Cl7mhOFM.cjs';
 export { N as NoteData, S as SpelledInterval, f as formatNote, m as midiToNote, n as noteToMidi, a as noteToPitchClass, p as parseNote, s as spelledInterval } from '../index-CGMZNCx6.cjs';
-export { K as KeyScale, N as NoteEvent } from '../types-MGP29r3t.cjs';
+
+/** A validated note retaining its position in the caller's original array. */
+type IndexedNoteEvent = {
+    note: NoteEvent;
+    originalIndex: number;
+    endBeat: number;
+};
+/** Binary-searchable, stable-sorted index over note onsets and active spans. */
+type NoteEventIndex = {
+    notes: IndexedNoteEvent[];
+    /** Latest-onset note sounding at `beat`, with later input order winning ties. */
+    at: (beat: number) => IndexedNoteEvent | undefined;
+    /** Whether one or more notes attack at `beat`. */
+    attacksAt: (beat: number) => boolean;
+    /** Unique attack beats strictly inside `(startBeat, endBeat)`. */
+    onsetsBetween: (startBeat: number, endBeat: number) => number[];
+};
+/**
+ * Validate and stable-sort note events once, then expose logarithmic onset and
+ * active-note lookups. Non-positive-duration notes may be retained for callers
+ * that intentionally filter them later, but never count as sounding.
+ */
+declare function createNoteEventIndex(events: NoteEvent[], options?: {
+    allowNonPositiveDuration?: boolean;
+}): NoteEventIndex;
 
 /**
  * Counterpoint classification of a harmonic interval.
@@ -202,9 +229,34 @@ declare const JUST_RATIOS: Record<number, [number, number]>;
  * (positive means the just interval is wider).
  *
  * @param semitoneClass Semitone class in [0, 12].
- * @returns The deviation in cents, or NaN if the class has no listed ratio.
+ * @returns The deviation in cents.
+ * @throws If `semitoneClass` is not an integer in [0, 12].
  * @category Pitch & Intervals
  */
 declare function justDeviationCents(semitoneClass: number): number;
 
-export { IntervalQuality, JUST_RATIOS, type Rng, TWELVE_TET, type Tuning, centsBetweenFreq, centsOfSteps, classifyInterval, createRng, edo, frequencyOf, isConsonantInterval, isPerfectInterval, justDeviationCents, nearestStep, ratioToCents };
+/** Default upper bound for synchronous event/window/candidate generation. */
+declare const DEFAULT_GENERATION_BUDGET = 1000000;
+/** Require a finite JavaScript number and return it unchanged. */
+declare function assertFiniteNumber(value: number, name: string): number;
+/** Require an integer in the inclusive range `[min, max]`. */
+declare function assertInteger(value: number, name: string, min?: number, max?: number): number;
+/** Require a positive safe integer, optionally capped by `max`. */
+declare function assertPositiveInt(value: number, name: string, max?: number): number;
+/** Require a finite number in the inclusive range `[min, max]`. */
+declare function assertRange(value: number, min: number, max: number, name: string): number;
+/** Reject work estimates that would exceed a synchronous generation budget. */
+declare function assertGenerationBudget(estimated: number, name: string, limit?: number): number;
+/** Validate a time signature, including additive grouping, before any early return. */
+declare function assertTimeSignature(ts: TimeSignature, name?: string): TimeSignature;
+/** Validate the finite fields of one timeline note event. */
+declare function assertNoteEvent(event: NoteEvent, name?: string, options?: {
+    allowNonPositiveDuration?: boolean;
+}): NoteEvent;
+/** Validate an event array and its allocation budget without copying it. */
+declare function assertNoteEvents(events: NoteEvent[], name?: string, options?: {
+    allowNonPositiveDuration?: boolean;
+    budget?: number;
+}): NoteEvent[];
+
+export { DEFAULT_GENERATION_BUDGET, type IndexedNoteEvent, IntervalQuality, JUST_RATIOS, NoteEvent, type NoteEventIndex, type Rng, TWELVE_TET, TimeSignature, type Tuning, assertFiniteNumber, assertGenerationBudget, assertInteger, assertNoteEvent, assertNoteEvents, assertPositiveInt, assertRange, assertTimeSignature, centsBetweenFreq, centsOfSteps, classifyInterval, createNoteEventIndex, createRng, edo, frequencyOf, isConsonantInterval, isPerfectInterval, justDeviationCents, nearestStep, ratioToCents };

package/dist/core/index.d.ts

@@ -1,6 +1,33 @@
-export { B as BarPosition, T as TimeSignature, b as barPositionToBeat, a as beatToBarPosition, c as beatsPerBar, f as formatTimeSignature, i as isCompound, d as isStrongBeat, m as metricWeight, p as parseTimeSignature, e as pulsesPerBar, t as tuplet } from '../index-Cl7mhOFM.js';
+import { N as NoteEvent } from '../types-MGP29r3t.js';
+export { K as KeyScale } from '../types-MGP29r3t.js';
+import { T as TimeSignature } from '../index-Cl7mhOFM.js';
+export { B as BarPosition, b as barPositionToBeat, a as beatToBarPosition, c as beatsPerBar, f as formatTimeSignature, i as isCompound, d as isStrongBeat, m as metricWeight, p as parseTimeSignature, e as pulsesPerBar, t as tuplet } from '../index-Cl7mhOFM.js';
 export { N as NoteData, S as SpelledInterval, f as formatNote, m as midiToNote, n as noteToMidi, a as noteToPitchClass, p as parseNote, s as spelledInterval } from '../index-CGMZNCx6.js';
-export { K as KeyScale, N as NoteEvent } from '../types-MGP29r3t.js';
+
+/** A validated note retaining its position in the caller's original array. */
+type IndexedNoteEvent = {
+    note: NoteEvent;
+    originalIndex: number;
+    endBeat: number;
+};
+/** Binary-searchable, stable-sorted index over note onsets and active spans. */
+type NoteEventIndex = {
+    notes: IndexedNoteEvent[];
+    /** Latest-onset note sounding at `beat`, with later input order winning ties. */
+    at: (beat: number) => IndexedNoteEvent | undefined;
+    /** Whether one or more notes attack at `beat`. */
+    attacksAt: (beat: number) => boolean;
+    /** Unique attack beats strictly inside `(startBeat, endBeat)`. */
+    onsetsBetween: (startBeat: number, endBeat: number) => number[];
+};
+/**
+ * Validate and stable-sort note events once, then expose logarithmic onset and
+ * active-note lookups. Non-positive-duration notes may be retained for callers
+ * that intentionally filter them later, but never count as sounding.
+ */
+declare function createNoteEventIndex(events: NoteEvent[], options?: {
+    allowNonPositiveDuration?: boolean;
+}): NoteEventIndex;
 
 /**
  * Counterpoint classification of a harmonic interval.
@@ -202,9 +229,34 @@ declare const JUST_RATIOS: Record<number, [number, number]>;
  * (positive means the just interval is wider).
  *
  * @param semitoneClass Semitone class in [0, 12].
- * @returns The deviation in cents, or NaN if the class has no listed ratio.
+ * @returns The deviation in cents.
+ * @throws If `semitoneClass` is not an integer in [0, 12].
  * @category Pitch & Intervals
  */
 declare function justDeviationCents(semitoneClass: number): number;
 
-export { IntervalQuality, JUST_RATIOS, type Rng, TWELVE_TET, type Tuning, centsBetweenFreq, centsOfSteps, classifyInterval, createRng, edo, frequencyOf, isConsonantInterval, isPerfectInterval, justDeviationCents, nearestStep, ratioToCents };
+/** Default upper bound for synchronous event/window/candidate generation. */
+declare const DEFAULT_GENERATION_BUDGET = 1000000;
+/** Require a finite JavaScript number and return it unchanged. */
+declare function assertFiniteNumber(value: number, name: string): number;
+/** Require an integer in the inclusive range `[min, max]`. */
+declare function assertInteger(value: number, name: string, min?: number, max?: number): number;
+/** Require a positive safe integer, optionally capped by `max`. */
+declare function assertPositiveInt(value: number, name: string, max?: number): number;
+/** Require a finite number in the inclusive range `[min, max]`. */
+declare function assertRange(value: number, min: number, max: number, name: string): number;
+/** Reject work estimates that would exceed a synchronous generation budget. */
+declare function assertGenerationBudget(estimated: number, name: string, limit?: number): number;
+/** Validate a time signature, including additive grouping, before any early return. */
+declare function assertTimeSignature(ts: TimeSignature, name?: string): TimeSignature;
+/** Validate the finite fields of one timeline note event. */
+declare function assertNoteEvent(event: NoteEvent, name?: string, options?: {
+    allowNonPositiveDuration?: boolean;
+}): NoteEvent;
+/** Validate an event array and its allocation budget without copying it. */
+declare function assertNoteEvents(events: NoteEvent[], name?: string, options?: {
+    allowNonPositiveDuration?: boolean;
+    budget?: number;
+}): NoteEvent[];
+
+export { DEFAULT_GENERATION_BUDGET, type IndexedNoteEvent, IntervalQuality, JUST_RATIOS, NoteEvent, type NoteEventIndex, type Rng, TWELVE_TET, TimeSignature, type Tuning, assertFiniteNumber, assertGenerationBudget, assertInteger, assertNoteEvent, assertNoteEvents, assertPositiveInt, assertRange, assertTimeSignature, centsBetweenFreq, centsOfSteps, classifyInterval, createNoteEventIndex, createRng, edo, frequencyOf, isConsonantInterval, isPerfectInterval, justDeviationCents, nearestStep, ratioToCents };

package/dist/core/index.js

@@ -8,14 +8,15 @@ import {
   justDeviationCents,
   nearestStep,
   ratioToCents
-} from "../chunk-ZXW5YIWK.js";
+} from "../chunk-AKLYPWIN.js";
 import {
   createRng
-} from "../chunk-BHUT2S5G.js";
+} from "../chunk-62QZKCJQ.js";
 import {
   barPositionToBeat,
   beatToBarPosition,
   beatsPerBar,
+  createNoteEventIndex,
   formatTimeSignature,
   isCompound,
   isStrongBeat,
@@ -23,7 +24,7 @@ import {
   parseTimeSignature,
   pulsesPerBar,
   tuplet
-} from "../chunk-MSWFZF7J.js";
+} from "../chunk-I5R7ZBJS.js";
 import {
   formatNote,
   midiToNote,
@@ -33,21 +34,40 @@ import {
   spelledInterval
 } from "../chunk-DYWFNC4A.js";
 import {
+  DEFAULT_GENERATION_BUDGET,
   IntervalQuality,
+  assertFiniteNumber,
+  assertGenerationBudget,
+  assertInteger,
+  assertNoteEvent,
+  assertNoteEvents,
+  assertPositiveInt,
+  assertRange,
+  assertTimeSignature,
   classifyInterval,
   isConsonantInterval,
   isPerfectInterval
-} from "../chunk-CCBLVAPK.js";
+} from "../chunk-FBQK3ZQN.js";
 export {
+  DEFAULT_GENERATION_BUDGET,
   IntervalQuality,
   JUST_RATIOS,
   TWELVE_TET,
+  assertFiniteNumber,
+  assertGenerationBudget,
+  assertInteger,
+  assertNoteEvent,
+  assertNoteEvents,
+  assertPositiveInt,
+  assertRange,
+  assertTimeSignature,
   barPositionToBeat,
   beatToBarPosition,
   beatsPerBar,
   centsBetweenFreq,
   centsOfSteps,
   classifyInterval,
+  createNoteEventIndex,
   createRng,
   edo,
   formatNote,

package/dist/{function-2bJW1Zp_.d.ts → function-DVH4Eusr.d.ts}

@@ -1,5 +1,5 @@
 import { K as KeyScale } from './types-MGP29r3t.js';
-import { C as Chord } from './index-CM5W4rcm.js';
+import { C as Chord } from './index-Bt4tOUD9.js';
 
 /**
  * Borrowed chords (modal interchange) and the Neapolitan.

package/dist/{function-r2sh-jOO.d.cts → function-DYt4iKsn.d.cts}

@@ -1,5 +1,5 @@
 import { K as KeyScale } from './types-MGP29r3t.cjs';
-import { C as Chord } from './index-BOBXBNwP.cjs';
+import { C as Chord } from './index-BNlGP86A.cjs';
 
 /**
  * Borrowed chords (modal interchange) and the Neapolitan.