coll.codebox

The number refers to the address of a message stored in coll. If a message is stored at that address, the stored message is output. If the stored message is a single symbol, it is always prepended with the word "symbol" when output.

• index [int]
  

The number refers to the address of a message stored in coll. If a message is stored at that address, the stored message is output. If the stored message is a single symbol, it is always prepended with the word "symbol" when output.

• index [float]
  

The first value is used as the address (the storage location within coll) at which to store the remaining items in the list. The address will always be stored as an int.

• index [int]
  
• data [list]
  

Double-click on the coll object to display the contents as text in an editing window. The data can be manually edited within this editor.

• double-click []
  

See the symbol listing.

• index [any]
  

The append message creates a new item associated with an index that is one larger than the highest current index. For example, if the coll is empty, append xyz will add an item xyz associated with the index 0. append xyz a second time will add another item xyz associated with the index 1.

• data [list]
  

Associates a symbol with the numeric address, provided that the number address already exists. After association, any reference to that symbol will be interpreted as a reference to the number address. Each number address can have only one symbol associated with it.

• address name [symbol]
  
• data index [int]
  

See the next listing.

Retrieves a message stored at the address named by the symbol. If no address is associated with the symbol, no output is produced. If the stored message is a single symbol, it is always prepended with the word "symbol" when output.

• index [symbol]
  

Clear all data

Removes the association between a symbol and the number address. The symbol will no longer have any meaning to coll.

• address name [symbol]
  
• data index [int]
  

Removes the data at the address provided. If the specified address is numeric, all higher numbered addresses are decremented by 1.

• index [any]
  

Sends all of the stored addresses out the 2nd outlet and all of the stored messages out the 1st outlet, in the order in which they are stored. A bang is sent out the 4th outlet when the dump is completed.

Sets the pointer (as used by the goto , next , and prev messages) to the last address.

Sets the file types which can be read and written into the coll object. The message filetype with no arguments restores the default file behavior.

• filetype [symbol]
  

Sets the flags used to save its contents within the patch that contains it. The message flags 1 0 notifies the object to save its contents as part of the patcher file. The message flags 0 0 causes the contents not to be saved.

• save-setting [int]
  
• unused [int]
  

Sets the pointer (as used by the goto , next , and prev messages) at a specific address, but does not trigger output. If the specified address does not exist, the pointer is set at the beginning of the collection. Data will be output in response to a subsequent bang , next , or prev message.

• index [list]
  

Inserts the message at the address specified by the number, incrementing all equal or greater addresses by 1 if necessary.

• index [int]
  
• data [list]
  

See the insert listing.

• index [int]
  
• data [list]
  

Counts the number of entries contained in the coll and sends the number out the 1st outlet.

Gets the highest value in any entry. An optional integer argument (defaults to '1') specifies an element position to use.

• element [int]
  

Appends data at the end of the data found at the specified index. If the address does not yet exist, it is created.

• index [int]
  
• data [list]
  

Gets the lowest value in any entry. An optional integer argument (defaults to '1') specifies an element position to use.

• element [int]
  

Sends the address and data stored at the current address, then sets the pointer to the next address. If the pointer is currently at the last address in the collection, it wraps around to the first address. If the address is a symbol rather than a number, 0 is sent out the second outlet.

Stores the message at the specified number address, with the specified symbol associated. This has the same effect as storing the message at an int address, then using the assoc message to associate a symbol with that number.

• index [int]
  
• association [symbol]
  
• data [list]
  

Replaces a data element with a new value. As an example, nsub 2 4 7 replaces the fourth element of address 2 with the value 7. Number values and symbols can both be substituted in this manner.

• index [int]
  
• position [int]
  
• data [any]
  

Returns the data element found at a specific position in the stored list and send it out the first outlet. As an example, nth 75 2 will output the second item in the list stored at address 75.

• index [int]
  
• position [int]
  

Opens a data editing window for the current data and bring it into focus.

Sends the address and data stored at the current address, then sets the pointer to the previous address. If the pointer is currently at the first address in the collection, it wraps around to the last address. If the address is a symbol rather than a number, 0 is sent out the second outlet.

With no arguments, read puts up a standard Open Document dialog box to choose a file to load. If an argument is provided, the named file is loaded.

• filename [symbol]
  

Loads the contents of the most recently read file. If no prior file load has occurred, the request is treated like a read message.

Changes the reference to the data in another named coll object. Changes to the data stored in any referenced coll will be shared by all other objects with the same name.

• object name [symbol]
  

Removes that address and its contents from the collection.

• index [any]
  

Renumbers data entries as consecutive and in increasing order. The optional argument specifies the starting number address for the data.

• data index [int]
  

Increment indices by one

• data index [int]
  

Increments the numerical indices for all data whose index is greater than the provided. This creates an open 'slot' for a subsequent add.

• data index [int]
  

Sorts the data into a specified order. If the first argument is -1 , the items are sorted in ascending order. If the first argument is 1 , the items are sorted in descending order.
The second argument specifies what data is used to sort the contents. If the second argument is -1 , the index (either number or symbol) associated with the data is used. If the second argument is not present or is 0 , the first item in the data is used. If the second argument is 1 or greater, that data elements is used for the sorting order.

• sort order (-1 or 1) [int]
  
• entry (-1, 0, or 1) [int]
  

Sets the pointer (used by the goto , next , and prev messages) to the first address in the coll.

Stores the message at an address named by the provided symbol. As an example, store triad 0 4 7 will store 0 4 7 at an address named triad .

• index [symbol]
  
• data [list]
  

Same as nsub , except that the message stored at the specified address is sent out after the item has been substituted.

• index [int]
  
• position [int]
  
• data [list]
  

Changes the symbol associated with data. The first argument is the new symbol to use, the second argument is the symbol associator to replace.

• new name [symbol]
  
• old name [symbol]
  

Exchanges the indices associated with two addresses. The data is unchanged, but the indexes that they use are swapped.

• index [int]
  
• index [int]
  

Close the data editing window

With no arguments, write puts up a standard Open Document dialog box to choose a filename to write. If an argument is provided, the name is used as a filename for storage.

• filename [symbol]
  

Saves the contents to the most recently written file. If no prior file write has occurred, the request is treated like a write message.