./../../src/complete-set.lsp

## complete-set/make-complete-set [ Functions ]

[ Top ] [ complete-set ] [ Functions ]

DESCRIPTION

     Create a complete-set object, which as an extension of the tl-set class
     allows checking for full sets: ones in which every note of *standard-scale*
     is present.

ARGUMENTS

     - A set of pitches. This can either take the form of a list of note-name
       symbols or a complete-set, tl-set or sc-set object.

OPTIONAL ARGUMENTS

     keyword arguments:
     - :id. An number, symbol or string that is to be the ID of the given
       complete-set object (see doc for sc-set).
     - :tag. A number, symbol or string that is secondary name, description, tag
       etc. for the given complete-set object. The :tag serves for
       identification but not searching purposes (see doc for named-object).
     - :subsets. An assoc-list of key/data pairs, in which the data is a list of
       note-name symbols that are a subset of the main set. One use for this
       keyword argument might be to create subsets that particular instruments
       can play; these would then be selected in the chord-function passed to
       the instrument object (see doc for sc-set).
     - :related-sets. An assoc-list of key/data pairs, similar to :subsets, only
       that the pitches given here do not have to be part of the main set. This
       can be used, for example, for pitches missing from the main set (see doc
       for sc-set).
     - :auto-sort. T or NIL to indicate whether the specified pitches (note-name
       symbols) are to be automatically sorted from lowest to highest.
      T = sort. Default = T. (see doc for sc-set)
     - :transposition. A number that is the number of semitones by which the
       pitches of the new complete-set are to be transposed when the object is
       created. Default = 0.  (see doc for tl-set)
     - :limit-upper. A note-name symbol or a pitch object to indicate the
       highest possible pitch in the given complete-set object to be
       created. (see doc for tl-set)
     - :limit-lower.  A note-name symbol or a pitch object to indicate the
       lowest possible pitch in the complete-set object to be created. (see doc
       for tl-set)
     - :complete. T, NIL, or 'CHROMATIC. This argument can be given at init, and
       if the set is not complete in the sense of T or 'CHROMATIC (all
       chromatic, equally-tempered notes are present in the set), a warning is
       printed. If the set is neither T nor 'CHROMATIC at init, then no warning
       will be issued. In both cases the COMPLETE slot of the given complete-set
       object will be set after checking the set.

RETURN VALUE

     A complete-set object.

EXAMPLE

    ;; Create a complete set using a list of note-name symbols and the default
    ;; values for the keyword arguments
    (make-complete-set '(d2 f2 a2 c3 e3 g3 b3 d4 gf4 bf4 df5 f5 af5 c6))

    =>
    COMPLETE-SET: complete: NIL
                  num-missing-non-chromatic: 12
                  num-missing-chromatic: 1
                  missing-non-chromatic: (BQS BQF AQS AQF GQS GQF FQS EQS EQF DQS
                                          DQF CQS)
                  missing-chromatic: (EF)
    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: 14, bounds-alert: T, copy: T
    LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL
    NAMED-OBJECT: id: NIL, tag: NIL,
    data: (D2 F2 A2 C3 E3 G3 B3 D4 GF4 BF4 DF5 F5 AF5 C6)

    ;; A new complete-set object can be created from tl-set and sc-set objects
    (let ((mcs (make-complete-set
                (make-tl-set '(d2 f2 a2 c3 e3 g3 b3 d4 gf4 bf4 df5 f5 af5)))))
      (pitch-symbols mcs))

    => (D2 F2 A2 C3 E3 G3 B3 D4 GF4 BF4 DF5 F5 AF5)

    (let ((mcs (make-complete-set
                (make-sc-set '(d2 f2 a2 c3 e3 g3 b3 d4 gf4 bf4 df5 f5 af5)))))
      (pitch-symbols mcs))

    => (D2 F2 A2 C3 E3 G3 B3 D4 GF4 BF4 DF5 F5 AF5)

    ;; Using the other keyword arguments
    (make-complete-set '(d2 f2 a2 e3 g3 b3 d4 gf4 bf4 df5 f5 af5)
                 :id 'csset
                 :subsets '((low (d2 f2 a2))
                            (mid (b3 d4)))
                 :related-sets '((not-playable (dqs2 eqf3)))
                 :transposition 3
                 :limit-upper 'g5
                 :limit-lower 'e2)

    =>
    COMPLETE-SET: complete: NIL
                  num-missing-non-chromatic: 12
                  num-missing-chromatic: 3
                  missing-non-chromatic: (BQS BQF AQS AQF GQS GQF FQS EQS EQF DQS
                                          DQF CQS)
                  missing-chromatic: (B FS EF)
    TL-SET: transposition: 3
            limit-upper:
    PITCH: frequency: 783.991, midi-note: 79, midi-channel: 0
    [...]
    data: G5
            limit-lower:
    PITCH: frequency: 82.407, midi-note: 40, midi-channel: 0
    [...]
    data: E2
    SC-SET: auto-sort: T, used-notes:
    RECURSIVE-ASSOC-LIST: recurse-simple-data: T
    [...]
    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:
    LOW: (F2 AF2 C3)
    MID: (D4 F4)
        related-sets:
    NOT-PLAYABLE: (DQS2 EQF3)
    SCLIST: sclist-length: 12, bounds-alert: T, copy: T
    LINKED-NAMED-OBJECT: previous: NIL, this: NIL, next: NIL
    NAMED-OBJECT: id: CSSET, tag: NIL,
    data: (F2 AF2 C3 G3 BF3 D4 F4 A4 CS5 E5)

SYNOPSIS

    (defun make-complete-set (set &key id tag subsets related-sets
                              (transposition 0) (auto-sort t)
                              limit-upper limit-lower complete)

## tl-set/complete-set [ Classes ]

[ Top ] [ tl-set ] [ Classes ]

NAME

     complete-set

     File:             complete-set.lsp

     Class Hierarchy:  named-object -> linked-named-object -> sclist -> sc-set ->
                       tl-set -> complete-set

     Version:          1.0.1

     Project:          slippery chicken (algorithmic composition)

     Purpose:          Implementation of the complete-set class which as an
                       extension of the tl-set class allows checking for full
                       sets: ones in which every note of the current scale is
                       present.

     Author:           Michael Edwards: m@michael-edwards.org

     Creation date:    10th August 2001

     $$ Last modified: 23:44:19 Thu May  3 2012 CEST

     SVN ID: $Id: complete-set.lsp 3360 2012-12-16 03:37:53Z medward2 $