recursive-assoc-list/sc-map [ Classes ]
[ Top ] [ recursive-assoc-list ] [ Classes ]
NAME
sc-map File: sc-map.lsp Class Hierarchy: named-object -> linked-named-object -> sclist -> circular-sclist -> assoc-list -> recursive-assoc-list -> sc-map Version: 1.0.12 Project: slippery chicken (algorithmic composition) Purpose: Implementation of the sc-map class for mapping rhythmic sequences, chords etc. to specific parts of a piece. The extension to the recursive-assoc-list class is in the data returned when get-data-from-palette is called: being a map, the data returned by the superclass get-data function is actually a reference into a palette. Instead of just returning this reference, with get-data-from-palette we then use this as a lookup into the palette slot. If the reference happens to be a list, then each element of the list is used as a reference into the palette and the resulting objects are returned in a list. TODO: When in a list of references, perhaps the rthm-seq references for a section, a single reference is also a list this can be one of two things: the reference is to a recursive palette, whereupon the data will simply be returned for that reference; or, the reference is a list of references that together build up an object consisting of the referenced smaller objects. This is the case when, for example, 4-bar sequences in one or more instruments are accompanied by groups of 4 single bar sequences in others: (2 ((bsn ((r1-1 r1-2 r1-3 r1-5) 20 1 ...)) (trb (2 23 3 ...)))) Author: Michael Edwards: m@michael-edwards.org Creation date: March 21st 2001 $$ Last modified: 10:29:24 Thu Feb 1 2024 CET SVN ID: $Id$
sc-map/count-ref [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DATE
February 13th 2018, Heidhausen
DESCRIPTION
Count the number of times a map reference occurs, e.g. how often a particular rthm-seq or set is used in a piece.
ARGUMENTS
- the sc-map reference - the reference we're counting
RETURN VALUE
an integer reflecting the number of occurences of <ref>
SYNOPSIS
(defmethod count-ref ((scm sc-map) ref)
sc-map/delete-nth-in-map [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DATE
05 Feb 2011
DESCRIPTION
Replace the element at the specified location within the specified list of a given sc-map object with NIL.
ARGUMENTS
- A list that is the map-ref; i.e., the path of IDs into the list to be searched. - An integer that is the zero-based index of the element to be returned from the specified list. - An sc-map object.
RETURN VALUE
Always returns NIL
EXAMPLE
(let ((mscm (make-sc-map 'scm-test '((1 ((vn (1 2 3 4 5)) (va (2 3 4 5 1)) (vc (3 4 5 1 2)))) (2 ((vn (6 7 8)) (va (7 8 6)) (vc (8 6 7)))) (3 ((vn (9)) (va (9)) (vc (9)))))))) (delete-nth-in-map '(1 vn) 1 mscm) (get-data-from-palette '(1 vn) mscm)) => NAMED-OBJECT: id: VN, tag: NIL, data: (1 NIL 3 4 5)
SYNOPSIS
(defmethod delete-nth-in-map (map-ref nth (scm sc-map))
sc-map/double [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DATE
13-Feb-2011
DESCRIPTION
Change the specified sequences of one or more specified players within an existing sc-map object to double the rhythms of the corresponding sequences of another specified player. This allows an existing map, for example, to have several players playing in rhythmic unison.
ARGUMENTS
- An sc-map object. - A section reference (i.e. section ID or list of section-subsection IDs). - An integer that is the 1-based number of the first sequence within the given section to be changed. - An integer that is the 1-based number of the last sequence within the given section to be changed. - The ID of the player whose part is to serve as the source for the doubling. - An ID or list of IDs of the player(s) whose parts are to be changed.
RETURN VALUE
Returns NIL.
EXAMPLE
;;; Create an sc-map with parts for players 'fl and 'cl containing only NILs ;;; and print the corresponding data. Double the second and third sequence of ;;; the 'vn part of that section into the 'fl and 'cl parts and print the same ;;; data again to see the change. (let ((scm (make-sc-map 'sc-m '((1 ((fl (nil nil nil)) (cl (nil nil nil)) (vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3)))))))) (print (get-data-data '(1 fl) scm)) (print (get-data-data '(1 cl) scm)) (double scm 1 2 3 'vn '(fl cl)) (print (get-data-data '(1 fl) scm)) (print (get-data-data '(1 cl) scm))) => (NIL NIL NIL) (NIL NIL NIL) (NIL SET3 SET2) (NIL SET3 SET2)
SYNOPSIS
(defmethod double ((scm sc-map) section-ref start-seq end-seq master-player doubling-players)
sc-map/get-all-data-from-palette [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DESCRIPTION
Given an sc-map object that has been bound to a palette object of any type, return all of the palette data contained in the given sc-map object as it has been allocated to the map, in the order in which it appears in the map. The given sc-map object must be bound to a palette object for this method to work. If no palette object has been bound to the given sc-map object, the method returns NIL and prints a warning.
ARGUMENTS
- An sc-map object.
RETURN VALUE
- A list of objects, the type depending on the given palette.
EXAMPLE
;; Create a set-palette object and an sc-map object, bind them using the ;; <palette> argument of the make-sc-map function, and print the results of ;; applying the get-all-data-from-palette method by printing the data of each ;; of the objects in the list it returns as note-name symbols. (let* ((sp (make-set-palette 'set-pal '((set1 ((c2 b2 a3 g4 f5 e6))) (set2 ((d2 c3 b3 a4 g5 f6))) (set3 ((e2 d3 c4 b4 a5 g6)))))) (scm (make-sc-map 'sc-m '((sec1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (sec2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (sec3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3))))) :palette sp))) (loop for cs in (get-all-data-from-palette scm) collect (pitch-list-to-symbols (data cs)))) => ((C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (D2 C3 B3 A4 G5 F6) (D2 C3 B3 A4 G5 F6) (E2 D3 C4 B4 A5 G6) (C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (C2 B2 A3 G4 F5 E6) (D2 C3 B3 A4 G5 F6) (C2 B2 A3 G4 F5 E6) (D2 C3 B3 A4 G5 F6) (C2 B2 A3 G4 F5 E6) (D2 C3 B3 A4 G5 F6) (C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (E2 D3 C4 B4 A5 G6) (C2 B2 A3 G4 F5 E6) (C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (D2 C3 B3 A4 G5 F6) (E2 D3 C4 B4 A5 G6) (D2 C3 B3 A4 G5 F6) (E2 D3 C4 B4 A5 G6)) ;; Applying the method to an sc-map object that is not bound to a palette ;; object returns NIL (let ((scm (make-sc-map 'sc-m '((sec1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (sec2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (sec3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3)))))))) (get-all-data-from-palette scm)) => NIL WARNING: sc-map::get-all-data-from-palette: palette slot is nil so can't return data from it.
SYNOPSIS
(defmethod get-all-data-from-palette ((scm sc-map))
sc-map/get-data-from-palette [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DESCRIPTION
Given an sc-map object that has been bound to a palette object of any type, return the palette data contained at the location within the given sc-map object as specified by the <IDs> argument. Deeper levels of the map can be accessed by specifying a path of IDs into the given sc-map object. If no palette object has been bound to the given sc-map object, the method returns the contents of the sc-map object at the specified location instead.
ARGUMENTS
- A symbol or list of symbols that is/are the ID or path of nested IDs within the given sc-map object for which the data is sought. - The sc-map object in which the data is sought.
OPTIONAL ARGUMENTS
- T or NIL to indicate whether to print a warning if the specified ID is not found in the given sc-map object. T = print warning. Default = T.
RETURN VALUE
The named object or list of named objects associated with the specified ID or path of IDs. If the specified ID is not found within the given sc-map object, the method returns NIL. If the optional <warn> argument is set to T, a warning is also printed in this case.
EXAMPLE
;;; Create a palette object and an sc-map object and bind them using the ;;; <palette> keyword argument of the make-sc-map function. Then apply the ;;; get-data-from-palette object to a nested ID in the sc-map object. Loop ;;; through the data of the named objects in the list returned and return them ;;; as note-name symbols. (let* ((sp (make-set-palette 'set-pal '((set1 ((c2 b2 a3 g4 f5 e6))) (set2 ((d2 c3 b3 a4 g5 f6))) (set3 ((e2 d3 c4 b4 a5 g6)))))) (scm (make-sc-map 'sc-m '((sec1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (sec2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (sec3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3))))) :palette sp))) (loop for cs in (get-data-from-palette '(sec1 vn) scm) collect (pitch-list-to-symbols (data cs)))) => ((C2 B2 A3 G4 F5 E6) (E2 D3 C4 B4 A5 G6) (D2 C3 B3 A4 G5 F6)) ;; If applied to an sc-map object that is not bound to a palette, the contents ;; of the sc-map object at the specified location are returned and a warning is ;; printed by default (let ((scm (make-sc-map 'sc-m '((sec1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (sec2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (sec3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3)))))))) (get-data-from-palette '(sec1 vn) scm)) => NAMED-OBJECT: id: VN, tag: NIL, data: (SET1 SET3 SET2) ************** , NO-PALETTE
SYNOPSIS
(defmethod get-data-from-palette (ids (scm sc-map) &optional (warn t))
sc-map/get-nth-from-map [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DESCRIPTION
Get the element located at the nth position within a given sc-map object. Both the map-ref (the path of IDs into the list to be searched) and the nth must be specified.
ARGUMENTS
- A list that is the map-ref; i.e., the path of IDs into the list to be searched. - An integer that is the zero-based index of the element to be returned from the specified list. - An sc-map object.
RETURN VALUE
Returns the element located at the given index. Returns NIL if the index does not exist.
EXAMPLE
;; Specify the path of IDs into the desired list ("map-ref") as a list, then
;; the position to be read from within the list located there.
(let ((mscm (make-sc-map 'scm-test
'((1
((vn (1 2 3 4 5))
(va (2 3 4 5 1))
(vc (3 4 5 1 2))))
(2
((vn (6 7 8))
(va (7 8 6))
(vc (8 6 7))))
(3
((vn (9))
(va (9))
(vc (9))))))))
(get-nth-from-map '(1 vn) 1 mscm))
=> 2
;; Returns NIL if the specified index does not exist
(let ((mscm (make-sc-map 'scm-test
'((1
((vn (1 2 3 4 5))
(va (2 3 4 5 1))
(vc (3 4 5 1 2))))
(2
((vn (6 7 8))
(va (7 8 6))
(vc (8 6 7))))
(3
((vn (9))
(va (9))
(vc (9))))))))
(get-nth-from-map '(3 vn) 1 mscm))
=> NIL
SYNOPSIS
(defmethod get-nth-from-map (map-ref nth (scm sc-map))
sc-map/get-nth-from-palette [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DESCRIPTION
Given an sc-map object that is bound to a palette object of any type, return the data of the palette object located at the nth position of the list found at the specified ID or path of nested IDs. If the given sc-map object is not bound to a palette object, NIL is returned instead.
ARGUMENTS
- An ID or list of IDs that are the path to the list within the given sc-map object from which the specified nth position is to be returned. - A zero-based integer that is the position within the list found at the path specified from which the given element is to be returned. - An sc-map object.
RETURN VALUE
- An element/object of the type contained within the given palette object of the given sc-map object.
EXAMPLE
;;; Create a set-palette object and an sc-map object, bind them using the ;;; <palette> object of the make-sc-map function, and apply the ;;; get-nth-from-palette method (let* ((sp (make-set-palette 'set-pal '((set1 ((c2 b2 a3 g4 f5 e6))) (set2 ((d2 c3 b3 a4 g5 f6))) (set3 ((e2 d3 c4 b4 a5 g6)))))) (scm (make-sc-map 'sc-m '((sec1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (sec2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (sec3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3))))) :palette sp))) (get-nth-from-palette '(sec1 vn) 0 scm)) => COMPLETE-SET: complete: NIL num-missing-non-chromatic: 12 num-missing-chromatic: 6 missing-non-chromatic: (BQS BQF AQS AQF GQS GQF FQS EQS EQF DQS DQF CQS) missing-chromatic: (BF AF FS EF D CS) TL-SET: transposition: 0 limit-upper: NIL limit-lower: NIL SC-SET: auto-sort: T, used-notes: RECURSIVE-ASSOC-LIST: recurse-simple-data: T num-data: 0 linked: NIL full-ref: NIL ASSOC-LIST: warn-not-found T CIRCULAR-SCLIST: current 0 SCLIST: sclist-length: 0, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: USED-NOTES, tag: NIL, data: NIL ************** **** N.B. All pitches printed as symbols only, internally they are all pitch-objects. subsets: related-sets: SCLIST: sclist-length: 6, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: SET1, tag: NIL, data: (C2 B2 A3 G4 F5 E6) ************** ;;; Applying the method to an sc-map object that is not bound to a palette ;;; object returns NIL (let ((scm (make-sc-map 'sc-m '((sec1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (sec2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (sec3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3)))))))) (get-nth-from-palette '(sec1 vn) 0 scm)) => NIL
SYNOPSIS
(defmethod get-nth-from-palette (sc-map-ref nth (scm sc-map))
sc-map/make-sc-map [ Functions ]
[ Top ] [ sc-map ] [ Functions ]
DESCRIPTION
Create an sc-map object, which will be used for mapping rhythmic sequences, chords etc. to specific parts of a piece.
ARGUMENTS
- The ID of the resulting sc-map object. - A list of data, most likely recursive.
OPTIONAL ARGUMENTS
keyword arguments: - :warn-not-found. T or NIL to indicate whether a warning is printed when an index which doesn't exist is used for look-up. T = warn. Default = T. - :recurse-simple-data. T or NIL to indicate whether to recursively instantiate a recursive-assoc-list in place of data that appears to be a simple assoc-list (i.e. a 2-element list). If NIL, the data of 2-element lists whose second element is a number or a symbol will be ignored, therefore remaining as a list. For example, this data would normally result in a recursive call: (y ((2 23) (7 28) (18 2))). T = recurse. Default = T. - :replacements. A list of lists in the format '(((1 2 vla) 3 20b) ((2 3 vln) 4 16a)) that indicate changes to individual elements of lists within the given sc-map object. (Often sc-map data is generated algorithmically, but individual elements of the lists need to be changed.) Each such list indicates a change, the first element of the list being the reference into the sc-map (the viola voice of section 1 subsection 2 in the first element here, for example), the second element being the nth of the data list to change for this key, and the third being the new data. - :palette. A palette object or NIL. If a palette object is specified or defined here, it will be automatically bound to the given sc-map object. Default = NIL
RETURN VALUE
An sc-map object.
EXAMPLE
;; Create an sc-map object with contents that could be used as a rthm-seq-map (make-sc-map 'scm-test '((1 ((vn (1 2 3 4 5)) (va (2 3 4 5 1)) (vc (3 4 5 1 2)))) (2 ((vn (6 7 8)) (va (7 8 6)) (vc (8 6 7)))) (3 ((vn (9)) (va (9)) (vc (9)))))) => SC-MAP: palette id: NIL RECURSIVE-ASSOC-LIST: recurse-simple-data: T num-data: 9 linked: NIL full-ref: NIL ASSOC-LIST: warn-not-found T CIRCULAR-SCLIST: current 0 SCLIST: sclist-length: 3, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: SCM-TEST, tag: NIL, data: ( NAMED-OBJECT: id: 1, tag: NIL, data: RECURSIVE-ASSOC-LIST: recurse-simple-data: T num-data: 3 linked: NIL full-ref: (1) ASSOC-LIST: warn-not-found T CIRCULAR-SCLIST: current 0 SCLIST: sclist-length: 3, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: "sub-ral-of-SCM-TEST", tag: NIL, data: ( NAMED-OBJECT: id: VN, tag: NIL, data: (1 2 3 4 5) [...] ;;; Create an sc-map object and automatically bind it to a set-palette object ;;; using the <palette> keyword argument. Then read the PALETTE slot of the ;;; sc-map created to see its contents. (let ((scm (make-sc-map 'scm-test '((1 ((vn (1 2 3 4 5)) (va (2 3 4 5 1)) (vc (3 4 5 1 2)))) (2 ((vn (6 7 8)) (va (7 8 6)) (vc (8 6 7)))) (3 ((vn (9)) (va (9)) (vc (9))))) :palette (make-set-palette 'set-pal '((set1 ((c2 b2 a3 g4 f5 e6))) (set2 ((d2 c3 b3 a4 g5 f6))) (set3 ((e2 d3 c4 b4 a5 g6)))))))) (palette scm)) => SET-PALETTE: PALETTE: RECURSIVE-ASSOC-LIST: recurse-simple-data: T num-data: 3 linked: NIL full-ref: NIL ASSOC-LIST: warn-not-found T CIRCULAR-SCLIST: current 0 SCLIST: sclist-length: 3, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: SET-PAL, tag: NIL, data: ( COMPLETE-SET: complete: NIL [...] data: (C2 B2 A3 G4 F5 E6) [...] COMPLETE-SET: complete: NIL [...] data: (D2 C3 B3 A4 G5 F6) [...] COMPLETE-SET: complete: NIL [...] data: (E2 D3 C4 B4 A5 G6) ) ;;; An example using replacements (make-sc-map 'sc-m '((1 ((vn (set1 set3 set2)) (va (set2 set3 set1)) (vc (set3 set1 set2)))) (2 ((vn (set1 set2 set1)) (va (set2 set1 set3)) (vc (set1 set3 set3)))) (3 ((vn (set1 set1 set3)) (va (set1 set3 set2)) (vc (set3 set2 set3))))) :replacements '(((1 va) 2 set2))) => SC-MAP: palette id: NIL RECURSIVE-ASSOC-LIST: recurse-simple-data: T num-data: 9 linked: NIL full-ref: NIL ASSOC-LIST: warn-not-found T CIRCULAR-SCLIST: current 0 SCLIST: sclist-length: 3, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: SC-M, tag: NIL, data: ( NAMED-OBJECT: id: 1, tag: NIL, data: RECURSIVE-ASSOC-LIST: recurse-simple-data: T num-data: 3 linked: NIL full-ref: (1) ASSOC-LIST: warn-not-found T CIRCULAR-SCLIST: current 0 SCLIST: sclist-length: 3, bounds-alert: T, copy: T LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL NAMED-OBJECT: id: "sub-ral-of-SC-M", tag: NIL, data: ( NAMED-OBJECT: id: VN, tag: NIL, data: (SET1 SET3 SET2) ************** NAMED-OBJECT: id: VA, tag: NIL, data: (SET2 SET2 SET1) ************** NAMED-OBJECT: id: VC, tag: NIL, data: (SET3 SET1 SET2) ************** ) [...]
SYNOPSIS
(defun make-sc-map (id scm &key (palette nil) (warn-not-found t) (recurse-simple-data t) (replacements nil))
sc-map/num-sequences [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DATE
January 27th 2018
DESCRIPTION
Return the number of sequences in the map as a whole (i.e. counting all sections and subsections). This method also works on subsections. Note that the first time this method is used it sets the :num-sequences slot which will then be used in subsequent queries until the data is changed. However, if you've not specifically called this method on a subsection, its slot will not yet be set.
ARGUMENTS
- an sc-map object
RETURN VALUE
An integer
SYNOPSIS
(defmethod num-sequences ((scm sc-map))
sc-map/remove-ref [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DATE
August 24th 2018
DESCRIPTION
Remove or replace a reference from a map. If there's no replacement then the data list will be shorter (if the reference is present) thereafter (which could cause problems .
ARGUMENTS
- an sc-map object - the section reference (symbol, list, etc.) - the reference in the data list that should be removed
OPTIONAL ARGUMENTS
- the replacement reference, if any. If, for example in a rthm-seq-map, you want to replace a rthm-seq reference with nil, so that the player sits out a sequence, then pass '(nil) as the replacement.
RETURN VALUE
The sc-map object.
SYNOPSIS
(defmethod remove-ref ((scm sc-map) section ref &optional replacement)
sc-map/shorten [ Methods ]
[ Top ] [ sc-map ] [ Methods ]
DATE
July 10th 2020, Heidhausen
DESCRIPTION
shorten the length of the map for a given section
ARGUMENTS
- the section reference - the new length (integer) - the sc-map object
RETURN VALUE
the shortened sc-map object
SYNOPSIS
(defmethod shorten (section new-length (scm sc-map))