# jit.op

Apply binary or unary operators

## Description

The jit.op object applies either a binary operator to two input matrices, or a unary operator to the left input matrix. A different operator may be specified for each plane, or a scalar may be specified via the val attribute as an alternate to using a second matrix.

## Examples

## Matrix Operator

Name | IOProc | Planelink | Typelink | Dimlink | Plane | Dim | Type |
---|---|---|---|---|---|---|---|

in2 | resamp | 1 | 1 | 1 | 1 | 1 | char long float32 float64 |

out | n/a | 1 | 1 | 1 | 1 | 1 | char long float32 float64 |

### More about Matrix Operators

### The Jitter MOP

Since the matrix is Jitter's focus, it is not surprising that the majority of Jitter objects fall in this category of Matrix Operators. Every Matrix operator has some number of matrix inputs and some number of matrix outputs. Matrix inputs are referred to by the names "in", "in2", "in3", etc., from left to right, and matrix outputs are referred to by the names "out", "out2", "out3", etc., from left to right--i.e. the names are appended by the input/output number except for the first (leftmost) input and first (leftmost) output which are simply named "in" and "out". We will refer to the input or output name names as the "I/O-name".

Matrix inputs and outputs typically each have their own matrices internally where information is kept. This is necessary because Jitter is an asynchronous framework (i.e. all the matrices don't arrive at all inputs at the same time). Various aspects of matrix inputs and outputs can be set using the command [I/O-name] combined with one of the following suffixes: "_dim" which will set the dimensions of the specified I/O matrix, "_type" which will set the type of the specified matrix, "_planecount" which will set the plane of the specified matrix, or "_name" which will set the name of the specified matrix. There is one special case which does not have an internal matrix and this is the first input "in". This is the case since this special input actually triggers the calculation of the matrix operator, so it doesn't need to be cached until a calulation takes place, unlike the other inputs. Therefore there is no mechanism to set the dim, planecount, type, or name of "in".

Matrix operators accept what we'll refer to as "matrix args"--i.e. [planecount (int)] [ * type * (symbol)] [dim (int list)] . if these arguments are present, the adapt attribute will be turned off, otherwise it will be turned on. If adapt mode is turned on, each time a matrix is received in the first input, there will also be the equivalent of setting the dim , planecount , and type attributes to that of the input matrix. If the other inputs and outputs are linked to these attributes, this will affect their linked attributes as well. See the "MOP" table to determine which inputs and outputs will be linked to which attributes when adapt mode is turned on. For the leftmost input this is not applicable, and hence all columns are labelled "n/a".

The jit.matrix object is a named matrix which may be used to matrix data storage and retrieval, resampling, and matrix type and planecount conversion operations.

### MOP Arguments

### planecount [int]

Explicitly sets the number of planes for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

### type [symbol]

Explicitly sets the type of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

### dimensions [list]

Explicitly sets the dimensions of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.

### MOP Attributes

### adapt [int]

Matrix adaptation flag (default = 0 if matrix arguments are present, otherwise 1) When the flag is set, the jit.matrix object will adapt to the incoming matrix planecount, type, and dimensions.

### [in/out]_dim [32 ints]

The matrix data dimensions (default = 1 1)

### [in/out]_name [symbol]

The input or output name of the matrix (default = UID)

### [in/out]_planecount [int]

The number of planes in matrix input our output data. Except in special cases, this value is equal to the planecount .

### [in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to type .

### [in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to type .

### outputmode [int]

Output mode (default = 1 (calculate and output matrix))

0 = No output

1 = Calculate and output the matrix

2 = Pass input (no calculation)

3 = Pass output (no calculation)

### type [int]

The matrix data type (default = char

Supported data types are char , long , float32 , or float64 .

### MOP Messages

### bang

### clear

### exportattrs

#### Arguments

### getattributes

*attribute-name*get

*get-value*set

*foo*set-value data-type(s)

*number-of-values*.

### getstate

*attribute-value1*

*attribute-value2*...

*attribute-valueN*.

### importattrs

#### Arguments

### jit_matrix

#### Arguments

### outputmatrix

### summary

*object-name*. The second and third lines describe the number of inlets and outlets for the object in the form summary (matrixinputcount/matrixoutletcount)

*number-of-(inlets/outlets)*. The fourth line describes the matrixoutput in the form summary matrixoutput

*descriptor*planelink

*planelink-value*typelink

*typelink-value*dimlink

*dimlink-value*types

*data-type(s)*. Each attribute for the object is then listed, one attribute per line. Each line listing takes the form summary attribute

*attribute-name attribute-value1 attribute-value2 ... attribute-valueN*.

## Attributes

### op [32 symbols]

The operator to be used (default = pass) If one operator is specified, it is applied to all planes. If multiple operators are specified, they are applied on a plane by plane basis.

Arithmetic Operators:pass = pass left input, no operator

* = multiplication (also mult )

/ = division (also div )

+ = addition (also add )

- = subtraction (also sub )

+m = addition modulo (char only) (also addm )

-m = subtraction modulo (char only) (also subm )

% = modulo (also mod )

min = minimum

max = maximum

abs = absolute value (unary)

avg = average

absdiff = absolute value of difference

fold = folding/mirrored modulo (float only)

wrap = wrapping/positive modulo (float only)

!pass = pass right input, no operator

!/ = right input divided by left input (flipped)

!- = right input minus left input (flipped)

!% = right input modulo left input (flipped)

ignore = leave previous output value

Trigonometric Operators: (float32/float64 only, unary except atan2)

sin = sine

cos = cosine

tan = tangent

asin = arcsine

acos = arccosine

atan = arctangent

atan2 = arctangent (binary)

sinh = hyperbolic sine

cosh = hyperbolic cosine

tanh = hyperbolic tangent

asinh = hyperbolic arcsine

acosh = hyperbolic arccosine

atanh = hyperbolic arctangent

Bitwise Operators: (long/char only)

& = bitwise and

| = bitwise or

^ = bitwise xor

~ = bitwise compliment (unary)

>> = right shift

<< = left shift

Logical operators

&& = logical and

|| = logical or

! = logical not (unary)

> = greater than

< = less than

>= = greater than or equal to

<= = less than or equal to

== = equal

!= = not equal

>p = greater than (pass)

<p = less than (pass)

>=p = greater than or equal to (pass)

<=p = less than or equal to (pass)

==p = equal (pass)

!=p not equal (pass)

Exponential/Logarithmic/Other: (float32/float64 only, unary except hypot and pow)

exp = e to the x

exp2 = 2 to the x

ln = log base e

log2 = log base 2

log10 = log base 10

hypot = hypotenuse (binary)

pow = x to the y (binary)

sqrt = square root

ceil = integer ceiling

floor = integer floor

round = round to nearest integer

trunc = truncate to integer

Possible values:

'*'

'/'

'+'

'sub'

'!/'

'!-'

'+m'

'-m'

'%'

'!%'

'min'

'max'

'avg'

'abs'

'absdiff'

'pass'

'!pass'

'fold'

'wrap'

'&'

'|'

'^'

'~'

'>>'

'<<'

'&&'

'||'

'!'

'>'

'<'

'>='

'<='

'=='

'!='

'>p'

'<p'

'>=p'

'<=p'

'==p'

'!=p'

'sin'

'cos'

'tan'

'asin'

'acos'

'atan'

'atan2'

'sinh'

'cosh'

'tanh'

'asinh'

'acosh'

'atanh'

'exp'

'exp2'

'ln'

'log'

'log2'

'log10'

'hypot'

'pow'

'sqrt'

'ceil'

'floor'

'round'

'trunc'

### val [32 atoms]

The value to use as right hand operand instead of a matrix (default = 0) If one value is specified it applies to all planes. If multiple values are specified they are applied on a plane by plane basis. ** IMPORTANT **: If the incoming matrix data has type char , then integers in the range 0-255 are mapped to the floating point data range 0.- .996 (A value of 1. (char 255) is not really 1. That value is not representable in 8-bit fixed point, since it would be 256. Thus, floating point values greater than 1. become 1.0 - 1/256.0, or 0.996).

### 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]

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]

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]

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.

## Messages

### int

### float

### list

## See Also

Name | Description |
---|---|

expr | Evaluate a mathematical expression |

jit.expr | Evaluate an expression to fill a matrix |

jit.dimop | Downsample using operators across dimensions |

jit.planeop | Operator across planes |

vexpr | Evaluate a math expression for a list |

Tutorial 3: Math Operations on a Matrix | Tutorial 3: Math Operations on a Matrix |

Tutorial 5: ARGB Color | Tutorial 5: ARGB Color |

Tutorial 9: More Mixing | Tutorial 9: More Mixing |

Tutorial 18: Iterative Processes and Matrix Re-Sampling | Tutorial 18: Iterative Processes and Matrix Re-Sampling |

Tutorial 45: Introduction to using Jitter within JavaScript | Tutorial 45: Introduction to using Jitter within JavaScript |