mwinter/compact_sets
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fix outdated docstring in _build_movement_maps

Browse source 
Update docstring to reflect index-based movement format: {src_idx: dest_idx}
instead of old pitch-based format.
This commit is contained in:
Michael Winter 2026-03-13 04:33:17 +01:00
parent a5efc548e5
commit 2df55d8c16
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
compact_sets.py
View file

@ -586,11 +586,10 @@ class HarmonicSpace:
""" """
Build all valid movement maps for c1 -> c2_transposed. Build all valid movement maps for c1 -> c2_transposed.
A movement map shows which pitch in c1 maps to which pitch in c2, A movement map shows which position in c1 maps to which position in c2.
including the cent difference for each movement.
Returns: Returns:
List of movement maps. Each map is {source_pitch: {"destination": dest_pitch, "cent_difference": cents}} List of movement maps. Each map is {src_idx: dest_idx}
There may be multiple valid maps if multiple changing pitches can be permuted. There may be multiple valid maps if multiple changing pitches can be permuted.
""" """
# Find common pitches (same pitch class in both) # Find common pitches (same pitch class in both)