Description

Performs mathematical calculations using C language-style mathematical operations. Operates on inputs that are lists rather than collections of single values.

Examples

Perform the same calculation on a whole list of input values

Discussion

Like its companion expr object, the vexpr object evaluates expressions that use the "variables" $i1-$i9 (the first to ninth inlets, taken as integers), $f1-$f9 (the inlets as floats) and $s1-$s9 (the inlets as symbols), and/or constants of the same types. The vexpr object also has a scalar mode of operation that lets you use the object's inlet value as a single-item list for evaluation with all items in an input list.

Arguments

expression [list]

The argument to the vexpr object is a mathematical expression composed of numbers, arithmetic operators such as + or *, comparisons such as < or >, C functions such as min () or pow (), names of table objects, and changeable arguments ($i, $f, and $s) for ints, floats, and symbols received in the inlets.

constant [number]

Numbers can be used as constants in the mathematical expression.

format [symbol]

Changeable arguments that specify data formats associated with an inlet are described using a combination of a data type ($i or $f) and an inlet number (example: $i2). The argument will be replaced by numbers received in the specified inlet.

table [symbol]

Changeable arguments that specify accessing data from a table are described using the argument $s and an inlet number which is replaced by the name of a table to be accessed. The argument should be immediately followed by a number in brackets specifying an address in the table. (Examples: $s2[7] or $s3[$i1].)

(other) [symbol]

Many C language math functions can be understood by vexpr. A function must be followed immediately by parentheses containing any arguments necessary to the function. If the function requires a comma between arguments, the comma must be preceded by a backslash (\) so that Max will not be confused by it. For example: (pow ($i1\,2) + $f2).

Attributes

scalarmode [int]

The word scalarmode, followed by a non-zero number, sets the scalar mode of operation. In scalar mode, sending a list of length 1 (i.e., a single value) will cause that value to be applied to each element of the other list. The message scalarmode 0 disables scalar mode.

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.

hidden [int] (default: 0)

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 [4 floats]

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

textjustification [int]

Sets the justification for the object's text.

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.

Messages

bang

Evaluates the expression and sends out the results, using the most recently received lists of numbers.

int

Arguments

number
[int]

An int or float received in any inlet is treated as a single-item list.

float

Arguments

number
[float]

An int or float received in any inlet is treated as a single-item list.

list

Arguments

numbers
[list]

The items of each list are used individually, in order from left to right, to replace the changeable argument in a series of evaluations of the expression. When a list is received in the left inlet, the expression is first evaluated using the first item of each list, then using the second item of each list, etc. The series of results of these evaluations is then sent out as a list.

Output

float

If the input in one of the inlets was a single number rather than a list, and the expression is evaluated as a float value, then a single result is sent out as a float rather than a list.

int

If the input in one of the inlets was a single number rather than a list, and the expression is evaluated as an integer value, then a single result is sent out as an int rather than a list.

list

When a list is received in the left inlet, vexpr uses the first item of the lists it has received in each of its different inlets, puts those items in place of the changeable arguments in the expression, and evaluates the expression. It then does the same with the second item in each list, and so on until it has used the last item of the shortest list. It then sends out all of the different results as a single list.