table

Store and edit an array of numbers

Examples

An array of any size and range can be stored, recalled, and modified

Arguments

name [symbol]

Optional

The argument gives a name to the table. Max looks for a file of the same name to load. If two or more table objects share the same names, they also share the same values.

Attributes

embed [int] (default: 1)

Toggles the ability to embed the table and save its data as part of the main patch. The default behavior is 1 (save the data).

name [symbol]

Specifies the name of a table. You can also specify the name of a table object using an argument. Max looks for a table of the s ame name which has been saved as a separate file. If two or more table objects share the same names, they also share the same values.

notename [int] (default: 0)

Toggles Y axis display using MIDI note names.

parameter_enable [int]

Enables use of this object with Max for Live Parameters.

range [int]

Specifies the range of values which can be displayed on the y axis of the editing window. A newly created table has a range of 128, from 0 to 127.

signed [int] (default: 0)

Toggles the ability to store and display signed integer values. A newly created table with signed values has a range of 256, from -128 to 127.

size [int]

Specifies the number of values stored in the table. The default is 128 values, indexed with numbers from 0 to 127.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to a range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values are likely to be outside of the 0-255 range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style

Typeint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

Same as a quantile message with a random number between 0 and 32,768 as an argument. See the quantile message for more details.

int

Arguments

index [int]
Retrieves the number by address from the table, and sends if out the left outlet.

  (inlet1)

Arguments

value [int]
Stores the value at the next index number received at the left inlet.

float

Arguments

index [float]
Convert to int

list

Arguments

index [int]
value [int]
The second number is stored in at the address (index) specified by the first number.

clear

Set all values to 0

const

Arguments

value [int]
Fill the table with a number

(mouse)

The values stored in table can be entered and edited graphically with the mouse. When a table object is first created in a patcher window, the table object’s graphic editing window is opened, and values can be entered by drawing with the mouse. The editing window provides a palette of graphic editing tools. When the patcher window is locked, the graphic editing window can be opened by double-clicking with the mouse on the table object.

dump

Sends all the numbers stored in the table out the left outlet in immediate succession, beginning with address 0.

cancel

Causes table to ignore a number received in the right inlet, so that the next number received in the left inlet will output a number, rather than storing a number at that address.

fquantile

Arguments

multiplier [float]
Given a number between zero and one, multiplies the number by the sum of all the numbers in the table. Then, table sends out the address at which the sum of the all values up to that address is greater than or equal to the result.

getbits

Arguments

address [int]
start [int]
bits [int]
Gets the value of one or more specific bits of a number stored in the table, and sends that value out the left outlet. The first argument is the address to query; the second argument is the starting bit location in the number stored at that address (the bit locations are numbered 0 to 31, from the least significant bit to the most significant bit); and the third argument specifies how many bits to the right of the starting bit location should be sent out. The specified bits are sent out the outlet as a single decimal integer.

goto

Arguments

index [int]
Sets a pointer to the address specified by the number. The pointer is set at the beginning of the table initially.

flags

Arguments

save-with-patcher [list]
dont-save [list]
Changes the table object’s saving options as found in the Inspector. The first argument affects the Save with Patcher option, and the second argument affects the Don’t Save option. If the argument is zero the option is unchecked, otherwise it is checked.

inv

Arguments

value [int]
Finds the first value which is greater than or equal to that number, and sends the address of that value out the left outlet.

length

Output the table size

max

Retrieve the maximum stored value

min

Retrieve the minimum stored value

load

Places the table in load mode. In load mode, every number received in the left inlet gets stored in the table, beginning at address 0 and continuing until the table is filled (or until the table is taken out of load mode by a normal message). If more numbers are received than will fit in the size of the table, additional numbers are ignored.

open

Opens the object’s graphic editor window and brings it to the foreground. Double-clicking on the table object in a locked patcher has the same effect.

next

Sends the value stored in the address pointed at by the pointer out the left outlet, then sets the pointer to the next address. If the pointer is currently at the last address in the table, it wraps around to the first address.

normal

Takes the table out of load mode and reverts it to normal operation. See the load message for more details.

quantile

Arguments

number [int]
Multiplies the incoming number by the sum of all the numbers in the table. This result is then divided by 2^15 (32,768). Then, table sends out the address at which the sum of all values up to that address is greater than or equal to the result.

prev

Causes the same output as the next message, but the pointer is then decremented rather than incremented. If the pointer is currently at the first address in the table, it wraps around to the last address.

set

Arguments

start [int]
values [list]
Stores values in certain addresses. The first argument specifies an address. The next number is the value to be stored in that address, and each number after that is stored in a successive address.

setbits

Arguments

address [int]
start [int]
count [int]
value [int]
Changes the value of one or more specific bits of a number stored in the table. The first argument is the address being referred to; the second argument is the starting bit location in the number stored at that address (the bit locations are numbered 0 to 31, from the least significant bit to the most significant bit); the third argument specifies how many bits to the right of the starting bit location should be modified, and the fourth argument is the value (stated in decimal or hexadecimal form) to which those bits should be set.

sum

Output the sum of all values

read

Arguments

filename [symbol]
Opens and reads data values from a file in Text or Max binary format. Without an argument, read opens a standard Open Document dialog to choose a file. If the file contains valid data, the entire contents of the existing table are replaced with the file contents.

send

Arguments

receive-name [symbol]
address [int]
Sends the value stored at the incoming address to all receive objects with that name.

refer

Arguments

name [symbol]
Sets the receiving table object to read its data values from the named table.

wclose

Close the graphic editing window

write

Opens a standard save file dialog for choosing a name to write data values from the table. The file can be saved in Text or Max binary format.

Output

bang

When the contents of a table have been changed by an edit in the graphic editing window, bang is sent out the right outlet.

int

All numbers sent out by table are sent out the left outlet.

See Also

Name Description
capture Store values to view or edit
coll Store and edit a collection of data
funbuff Store pairs of numbers
histo Create a histogram of numbers received
itable Data table editor
multislider Display data as sliders or a scrolling display
text Format messages as a text file
Max Basic Tutorial 17: Data Structures And Probability Max Basic Tutorial 17: Data Structures And Probability