Skip to main content

Crate acorde_analysis

Crate acorde_analysis 

Source
Expand description

Deterministic, explainable music analysis over acorde_core::Score.

Structs§

AnalysisCache
A deterministic, bounded cache for complete analysis results.
AnalysisCacheStats
Counters for measuring analysis-cache reuse.
AnalysisChangeExplanation
A score diff together with the explanations affected at one source address.
AnalysisCounts
Predicted category counts used by the benchmark report.
AnalysisDiff
Deterministic category-level diff between two analysis results.
AnalysisEditResult
Analysis result and its deterministic diff from a previous result.
AnalysisPassResult
Result of one registered extension pass.
AnalysisProvenance
One deterministic explanation attached to a source note address.
AnalysisRefreshPlan
Dependency-aware refresh plan for a score edit.
AnalysisRegion
A changed part/staff measure interval used by incremental editor planning.
AnalysisResult
Deterministic output of the chord-analysis pass.
BenchmarkCase
One benchmark fixture and its hand-verified expectation.
BenchmarkCaseReport
Precision, recall, and explanation-completeness for one benchmark case.
BenchmarkExpectation
Hand-verified expected counts for one analysis benchmark fixture.
BenchmarkFailure
A category-level benchmark mismatch.
BenchmarkSuiteReport
Aggregate results for a deterministic benchmark suite.
CadenceCandidate
A cadence transition inferred only from adjacent, explicitly labeled chords.
ChordLabel
A chord label with source evidence and the rule that produced it.
IntervalObservation
A consecutive melodic interval with addresses for both source notes.
KeyEstimate
A deterministic key candidate ranked by duration-weighted diatonic pitch coverage.
LocalKeyEstimate
Opt-in local key estimate for one physical measure and a centered measure window.
MotifOccurrence
One source span matching a motif pattern.
MotifPattern
A repeated melodic interval pattern with all matching source occurrences.
PhraseBoundary
A phrase boundary supported by an explicit rest at the end of a measure.
QuartetNote
One monophonic written note in a located two-voice comparison.
SatbDiagnostic
A typed SATB constraint finding with source addresses for UI selection.
VerticalAnalysisReport
Sonorities and physical-bar alignment diagnostics in source order.
VerticalCadenceReport
Opt-in cadence candidates inferred from located vertical sonorities.
VerticalSonority
One chord heard at a written beat, using notes active across all parts and voices.
VerticalTimelineIssue
A part/staff whose physical bar cannot safely be aligned with the others.
VoiceLeadingObservation
Voice-leading observation for two adjacent voices at an aligned event.
VoiceLeadingQuartet
Four sounding notes at two successive aligned events in distinct voices.

Enums§

AnalysisCacheError
Errors returned when configuring the bounded analysis cache.
AnalysisCategory
One complete-analysis category that can change between two results.
AnalysisPassError
Validation failures for a registered analysis pass set.
BenchmarkCategory
An analysis category that can be compared in a benchmark report.
CadenceKind
Supported cadence transition families.
PhraseBoundaryReason
Evidence categories for phrase boundaries.
SatbDiagnosticKind
SATB constraint families reported by the deterministic pass.
SatbSeverity
User-facing seriousness of a SATB diagnostic.
VerticalTimelineIssueKind

Constants§

ANALYSIS_SCHEMA_VERSION
Version of the serialized analysis result contract.

Traits§

AnalysisPass
A host- or application-provided deterministic analysis extension.

Functions§

affected_categories_for_change_hint
Return the complete-analysis categories that a dirty engine hint may affect.
analysis_cache_key
Return the current schema-versioned cache key without running the analysis passes.
analysis_provenance
Return every analysis finding whose evidence contains the supplied source address.
analysis_refresh_plan
Build a conservative refresh plan from an engine change hint.
analyze_arpeggiated_bars_in_key_report
As analyze_arpeggiated_bars_report, using a caller-supplied concert key.
analyze_arpeggiated_bars_report
Add conservative opt-in chords when notes within a bar arpeggiate a complete tertian chord. A bar start uses its first half, and a later onset may use notes up to the next detected sonority within half a beat. A three-note melody is never promoted by the bar-start rule. Evidence includes the later notes used for each inference.
analyze_batch
Analyze a finite batch in input order.
analyze_cadences
Find explicit cadence transitions in the order they occur within each voice.
analyze_chords
Backwards-compatible name for the complete score analysis pass.
analyze_chords_in_region
Analyze chord labels only inside an optional part/staff measure region.
analyze_intervals
Analyze adjacent pitched notes in every voice without inferring missing events.
analyze_intervals_in_region
Analyze intervals whose endpoints touch an optional part/staff measure region.
analyze_motifs
Find repeated three-note melodic interval patterns, resetting at rests.
analyze_phrase_boundaries
Report measure-ending rests as explicit, conservative phrase boundaries.
analyze_satb
Analyze SATB constraints using the same aligned voice events as voice-leading analysis.
analyze_satb_in_region
Analyze SATB diagnostics inside an optional part/staff measure region.
analyze_score
Analyze every voice that contains at least two pitched notes in a measure.
analyze_selected_categories
Recompute only the requested categories and carry forward the remaining categories.
analyze_selected_categories_in_region
Recompute selected categories with an optional bounded region for local passes.
analyze_stream
Analyze scores lazily, one result per input score.
analyze_vertical_cadences_in_key_report
As analyze_vertical_cadences_report, with a caller-supplied concert key.
analyze_vertical_cadences_report
Find conservative dominant-to-tonic resolutions from opt-in vertical chords.
analyze_vertical_sonorities
Infer chords from simultaneous sounding notes, retaining authored chord symbols.
analyze_vertical_sonorities_in_key
Infer vertical chords in an independently chosen global key.
analyze_vertical_sonorities_in_key_report
analyze_vertical_sonorities_report
analyze_voice_leading
Check simultaneously sounding notes in adjacent voices for motion and parallel intervals.
analyze_voice_leading_in_region
Analyze voice-leading observations inside an optional part/staff measure region.
analyze_voice_leading_quartets
Locate two-voice quartets across parts, staves, and physical bar lines.
benchmark_case
Run one offline benchmark case using count-based hand-verified annotations.
chord_name
Return the stable chord spelling as a compact human-readable label.
diff_analysis
Compare two complete results in stable category order.
estimate_keys
Estimate major/minor keys from pitch coverage, preserving tied candidates.
estimate_keys_with_aarden_essen_profile
Rank all major/minor key spellings by the Aarden-Essen tonal profile.
estimate_keys_with_tonal_profile
Rank the equal-coverage candidates from estimate_keys by tonal profile.
estimate_local_keys_with_aarden_essen_profile
Estimate a key for each physical measure from a centered pitch-class window.
explain_analysis_change
Compare two analysis results and explain the findings attached to one source address.
run_analysis_passes
Run extension passes in stable ID order after validating their identifiers.
run_benchmark
Run benchmark cases in input order; no filesystem or network access is used.
run_benchmark_suite
Run a benchmark suite and aggregate its case-level metrics.
score_fingerprint
Return a deterministic, non-cryptographic fingerprint for a canonical score.