Feat: PcSet.notes

packages/pcset/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @tonaljs/pcset
 
+## 4.9.0
+
+### Minor Changes
+
+- f21525b: Add `Pcset.notes()` function that returns the ordered pitch class notes of the given set
+
 ## 4.8.3
 
 ### Patch Changes

packages/pcset/README.md

@@ -68,6 +68,15 @@ Pcset.intervals(["c", "d", "e"]); // => ["1P", "5P", "7M"]
 Pcset.intervals(["D", "F", "A"]); // => ["2M", "4P", "6M"]
 ```
 
+### `notes(pcset: string | number | string[]) => string[]`
+
+Given a pcset or a list of notes, it returns the sorted pitch class notes:
+
+```js
+Pcset.notes(["D3", "A3", "Bb3", "C4", "D4", "E4", "F4", "G4", "A4"]); // => ["C", "D", "E", "F", "G", "A", "Bb"]
+Pcset.notes("101011010110"); // => ["C", "D", "E", "F", "G", "A", "Bb"]
+```
+
 ### `isIncludedIn(parent: Set) => (note: string) => boolean`
 
 Test if a note is included in the given set. This function is currified:

packages/pcset/index.ts

@@ -8,6 +8,7 @@ import {
   deprecate,
   interval,
   note,
+  transpose,
 } from "@tonaljs/core";
 
 /**
@@ -157,6 +158,10 @@ export function chromaToIntervals(chroma: PcsetChroma): IntervalName[] {
   return intervals;
 }
 
+export function notes(set: Set): NoteName[] {
+  return get(set).intervals.map((ivl) => transpose("C", ivl));
+}
+
 /**
  * Get a list of all possible pitch class sets (all possible chromas) *having
  * C as root*. There are 2048 different chromas. If you want them with another
@@ -310,6 +315,7 @@ export default {
   isEqual,
   filter,
   modes,
+  notes,
   // deprecated
   pcset,
 };

packages/pcset/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonaljs/pcset",
-  "version": "4.8.3",
+  "version": "4.9.0",
   "description": "Functions to work with midi numbers",
   "keywords": [
     "note",

packages/pcset/test.ts

@@ -121,6 +121,16 @@ describe("@tonaljs/pcset", () => {
     expect(Pcset.filter($("c"))($("c2 c#2 d2 c3 c#3 d3"))).toEqual($("c2 c3"));
   });
 
+  test("notes", () => {
+    expect(Pcset.notes($("c d e f g a b"))).toEqual($("C D E F G A B"));
+    expect(Pcset.notes($("b a g f e d c"))).toEqual($("C D E F G A B"));
+    expect(Pcset.notes($("D3 A3 Bb3 C4 D4 E4 F4 G4 A4"))).toEqual(
+      $("C D E F G A Bb"),
+    );
+    expect(Pcset.notes("101011010110")).toEqual($("C D E F G A Bb"));
+    expect(Pcset.notes(["blah", "x"])).toEqual([]);
+  });
+
   test("modes", () => {
     expect(Pcset.modes($("c d e f g a b"))).toEqual([
       "101011010101",

packages/tonal/CHANGELOG.md

@@ -1,5 +1,16 @@
 # tonal
 
+## 5.2.0
+
+### Minor Changes
+
+- f21525b: Add `Pcset.notes()` function that returns the ordered pitch class notes of the given set
+
+### Patch Changes
+
+- Updated dependencies [f21525b]
+  - @tonaljs/[email protected]
+
 ## 5.1.3
 
 ### Patch Changes

packages/tonal/__snapshots__/test.ts.snap

@@ -177,6 +177,7 @@ exports[`tonal Modules exports functions 1`] = `
     "isSubsetOf",
     "isSupersetOf",
     "modes",
+    "notes",
     "num",
     "pcset",
   ],
@@ -191,6 +192,7 @@ exports[`tonal Modules exports functions 1`] = `
     "isSubsetOf",
     "isSupersetOf",
     "modes",
+    "notes",
     "num",
     "pcset",
   ],

packages/tonal/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tonal",
-  "version": "5.1.3",
+  "version": "5.2.0",
   "description": "tonaljs music theory library",
   "keywords": [
     "music",
@@ -28,7 +28,7 @@
     "@tonaljs/midi": "^4.9.1",
     "@tonaljs/mode": "^4.8.2",
     "@tonaljs/note": "^4.10.1",
-    "@tonaljs/pcset": "^4.8.3",
+    "@tonaljs/pcset": "^4.9.0",
     "@tonaljs/progression": "^4.8.2",
     "@tonaljs/range": "^4.8.2",
     "@tonaljs/roman-numeral": "^4.8.1",