NamedList | SuperCollider 3.13.0 Help

Description

NOTE: NamedList is now in adclib! NamedList is a copy of NamedList which will stay here for backwards compatibility.

Like a List, a NamedList has an array of items which can be accessed by index. Like a dictionary, its items can also be accessed by names. Items can be added and removed and replaced by name. It also supports pseudo-object style like a dict.

Not used yet in Modality.

NOTE: NamedList is designed primarily for semantic clarity, to make storage as text more clearly readable for humans, and to ensure the intended order of iteration.

NamedList also does quite efficient lookup: put, at methods are reasonably fast, and direct lookup with NamedList.dict[key] or NamedList.array[index] is almost as fast as with Array and Event.

add, remove, removeAt methods are slower than with arrays or dicts, due to the overhead of keeping array, names and dict in sync. This design assumes that lookup will happen several orders of magnitude more often than add/remove.

// make a new NamedNist
n = NamedList([ \a, 4, \b, 5, \c, 6 ]);

//  access list-like by index, get and set
n[0];
n.at([0, 2]);     // at supports multiple values by index
n[0] = 12;
n.put(2, 13);

//  access dict-like by name, get and set
n[\a];
n.at(\a);
n.at([\b, \c]);    // multiple values
n.at([\a, 2]);     // can also mix indices and keys

n[\a] = 123;
n.put(\d, 7);     // new names get added to the end

// access by name as pseudo-method (if n.know == true)
n.a;
n.eee;
n.eee = 555;     // putting also works by pseudo-method

// internals, can be used for faster lookup
n.dict;
n.array.postcs;
n.names.postcs;

// replaces item if name already there, else does addLast
n.basicAdd (\a, 123)
n.basicAdd (\xyz, 123)

// these all put items in specific places in the order.
n.addFirst(\x, 123);
n.addLast (\zzz, 987);

// add or move a named item relative to given name.
// if the name to add is already in use,
// it is moved to the position indicated.
// if the name where to add is missing,
// addBefore does addFirst, addAfter does addLast.
n.addBefore (\y, 234, \a);
n.addAfter (\y, 23, \a); // this moves \y!

n.do { |val, key, i| [val * 100, key, i].postcs };
n.collect { |val, key, i| val * 100 };

Class Methods

.new

.fromPairs

create new NamedList from array of pairs

n = NamedList([ \a, 4, \b, 5, \c, 6 ]);

.fromDict

create new NamedList from dict and optional ordered names or sortFunc.n = NamedList.fromDict((a: 1, b: 3, c: 5), [\c, \a, \b]); n = NamedList.fromDict((a: 1, c: 5, b: 3), sortFunc: { |a, b| a > b });

.newUsing

create new NamedList from array of values and namesNamedList.newUsing([1, 3, 5], [\a, \b, \c]);

.fromAssocs

create new NamedList from array of associations:n = NamedList.fromAssocs([\a -> 1, \b -> 3, \c -> 5]);

Instance Methods

.names

the ordered list of names

n.names.postcs;

.dict

the unordered dict of items - for fast access by key

n.dict.postcs;

.know

flag whether to use pseudomethods or notn.know; n.know = false;

.at

put by key (name), index or collection of keys/indicesn[0]; n.at(0); n.at([0, 2]); // access dict-like by name, get and set n[\a]; n.at(\a); n.at([\b, \c]); // multiple values n.at([\a, 2]); // can also mix indices and keys n.a; // if n.know == true, can access by name as pseudo-method n.know = true; n.a;

.put

put by key (name) or indexn[0] = 11; n.put(2, 33); n.put(\a, 111); n.put(\c, 333); n[\x] = 999; n.a = 123; // works if n.know is true

.add

add by name; if name exists, replaces item at name, else adds item to end n.add(\aaa, \xyz);

.do

.collect

like List.do, collect

helpfile source: HelpSource/Classes/NamedList.schelp
link::adclib/Classes/NamedList::

NamedList
Extension

Description

Class Methods

.new

.fromPairs

.fromDict

.newUsing

.fromAssocs

Instance Methods

.names

.dict

.know

.at

.put

.add

.remove

.removeAt

.addBefore

.addAfter

.addFirst

.addLast

.replace

.do

.collect

NamedListExtension

Description

Class Methods

.new

.fromPairs

.fromDict

.newUsing

.fromAssocs

Instance Methods

.names

.dict

.know

.at

.put

.add

.remove

.removeAt

.addBefore

.addAfter

.addFirst

.addLast

.replace

.do

.collect

NamedList
Extension