Math / Arithmetic, Double, Integer Modules

Introduction

This document describes the built-in Flow Graph modules of the following categories for compounds:

• Math / Arithmetic - Modules that compute arithmetic, trigonometric, interpolation, and element-wise numeric operations.
• Math / Arithm Double - Modules that perform double-precision arithmetic operations on numeric values.
• Math / Arithm Integer - Modules that perform integer arithmetic, bitwise operations, and discrete numeric transforms.

Math / Arithmetic

This section describes the built-in Flow Graph modules that compute arithmetic, trigonometric, interpolation, and element-wise numeric operations.

Absolute

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes the absolute value. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the non-negative magnitude of each component.

Add

• Category: Math / Arithmetic
• Access: All editions.
• Function: Adds two values. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - First operand (element-wise or broadcast).
  • ⏺  B (vector) - Second operand (element-wise or broadcast).
• Output pins:
  • ⏺  Out (vector) - Carries the sum.

Angle Normalize

• Category: Math / Arithmetic
• Access: All editions.
• Function: Wraps degree angles to a signed or unsigned circle range. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
  • ⏺  Signed (logical) - When on, normalizes into the signed angle range; when off, into the unsigned range.
• Output pins:
  • ⏺  Out (vector) - Carries the wrapped angle in degrees.

Arccosine

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes inverse cosine in degrees after clamping each input to [-1, 1]. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the angle in degrees for each component.

Arctangent

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes the angle in degrees from Y and X using atan2. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  Y (vector) - First argument to atan2 (typically the vertical component).
  • ⏺  X (vector) - Second argument to atan2 (typically the horizontal component).
• Output pins:
  • ⏺  Out (vector) - Carries the angle in degrees for each component pair.

Arcsine

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes inverse sine in degrees after clamping each input to [-1, 1]. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the angle in degrees for each component.

Array Add

• Category: Math / Arithmetic
• Access: All editions.
• Function: Adds values along a chain of array-compound instances over a selectable index span. Each step adds operands element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  In (vector) - The source value
  • ⏺  Start Index (integer) - First array-instance index (1-based) included in the chain.
  • ⏺  Count (integer) - How many consecutive instances starting at StartIndex participate.
• Output pins:
  • ⏺  Out (vector) - Carries the chained result across the selected instances.

Array Multiply

• Category: Math / Arithmetic
• Access: All editions.
• Function: Multiplies values along a chain of array-compound instances over a selectable index span. Each step multiplies operands element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  In (vector) - The source value
  • ⏺  Start Index (integer) - First array-instance index (1-based) included in the chain.
  • ⏺  Count (integer) - How many consecutive instances starting at StartIndex participate.
• Output pins:
  • ⏺  Out (vector) - Carries the chained result across the selected instances.

Average

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes the arithmetic mean of two values, or a circular midpoint when circular mode is on. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - First value to average.
  • ⏺  B (vector) - Second value to average.
  • ⏺  Circular (logical) - When on, averages on a circle with CircularRange as the period; when off, uses the arithmetic mean.
  • ⏺  Circular Range (scalar) - Wrap length used as the circular period when circular averaging is on.
• Output pins:
  • ⏺  Out (vector) - Carries the mean or circular midpoint.

Ceiling

• Category: Math / Arithmetic
• Access: All editions.
• Function: Rounds upward to the nearest integer using the ceiling function. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the ceiling of each component.

Clamp

• Category: Math / Arithmetic
• Access: All editions.
• Function: Constrains values to an interval using a clamp or circular wrap through that interval. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
  • ⏺  Minimum (scalar) - Lower end of the allowed interval (and wrap span when circular mode is on).
  • ⏺  Maximum (scalar) - Upper end of the allowed interval.
  • ⏺  Circular (logical) - When on, wraps values through the interval instead of clamping at the bounds.
• Output pins:
  • ⏺  Out (vector) - Carries the clamped or wrapped value.

Cosine

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes cosine of angles given in degrees. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the cosine of each angle component.

Divide

• Category: Math / Arithmetic
• Access: All editions.
• Function: Divides the first value by the second; a zero divisor yields zero. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - Dividend (numerator).
  • ⏺  B (vector) - Divisor; zero yields output zero for that component.
• Output pins:
  • ⏺  Out (vector) - Carries the quotient.

Exponential

• Category: Math / Arithmetic
• Access: All editions.
• Function: Raises e to the given power. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries e raised to each exponent component.

Floor

• Category: Math / Arithmetic
• Access: All editions.
• Function: Rounds downward to the nearest integer using the floor function. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the floor of each component.

Function

• Category: Math / Arithmetic
• Access: All editions.
• Function: Samples the selected curve at the input coordinates. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
  • ⏺  Curve (curve) - Curve whose ValueAt supplies the output for each component position.
• Output pins:
  • ⏺  Out (vector) - Carries the sampled curve values.

Invert

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes one minus the input. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries one minus each input component.

Lerp

• Category: Math / Arithmetic
• Access: All editions.
• Function: Linearly interpolates between A and B using Factor, with optional circular blending, factor clamping, and shortcuts when Factor is exactly 0 or 1. Blending is performed element-wise on A and B. A single-component operand among A or B is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - Value corresponding to Factor 0.
  • ⏺  B (vector) - Value corresponding to Factor 1.
  • ⏺  Factor (scalar) - Blend weight from A toward B (optionally clamped to 0–1).
  • ⏺  Clamp (logical) - When on, clamps Factor to the range 0–1 before blending.
  • ⏺  Circular (logical) - When on, interpolates along a circular path using CircularRange as the period.
  • ⏺  Circular Range (scalar) - Wrap length for circular blending.
  • ⏺  Force Both (logical) - When on, both inputs are pulled continuously; when off, only the active inputs are pulled.
• Output pins:
  • ⏺  Out (vector) - Carries the interpolated value.

Logarithm

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes the natural logarithm; non-finite results become zero. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the natural logarithm, or zero when that value would be non-finite.

Maximum

• Category: Math / Arithmetic
• Access: All editions.
• Function: Selects the larger of two values. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - First operand.
  • ⏺  B (vector) - Second operand.
• Output pins:
  • ⏺  Out (vector) - Carries the component-wise maximum.

Minimum

• Category: Math / Arithmetic
• Access: All editions.
• Function: Selects the smaller of two values. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - First operand.
  • ⏺  B (vector) - Second operand.
• Output pins:
  • ⏺  Out (vector) - Carries the component-wise minimum.

Modulo

• Category: Math / Arithmetic
• Access: All editions.
• Function: Maps a value into a repeating span with an optional base offset; a zero modulus yields the base. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - Value reduced into the repeating range.
  • ⏺  B (vector) - Modulus span; zero yields output equal to Base.
  • ⏺  Base (scalar) - Origin added after the remainder; also the output when B is zero.
• Output pins:
  • ⏺  Out (vector) - Carries Base plus the wrapped remainder when B is non-zero.

Multiply

• Category: Math / Arithmetic
• Access: All editions.
• Function: Multiplies two values. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - First factor.
  • ⏺  B (vector) - Second factor.
• Output pins:
  • ⏺  Out (vector) - Carries the product.

Negate

• Category: Math / Arithmetic
• Access: All editions.
• Function: Negates the input. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the negated value.

Power

• Category: Math / Arithmetic
• Access: All editions.
• Function: Raises a base to an exponent, with optional signed-base handling; non-finite powers become zero. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - Base.
  • ⏺  B (vector) - Exponent applied to each base component.
  • ⏺  Symmetric (logical) - When on, preserves the sign of negative bases by negating the absolute-value power.
• Output pins:
  • ⏺  Out (vector) - Carries the power, or zero when the result would be non-finite.

Reciprocal

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes one divided by the input; zero input yields zero. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the reciprocal, or zero for a zero input component.

Round

• Category: Math / Arithmetic
• Access: All editions.
• Function: Rounds to the nearest integer using floor(value + ½). The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the rounded value.

Sign

• Category: Math / Arithmetic
• Access: All editions.
• Function: Outputs −1, 0, or 1 according to the sign of the input. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries −1, 0, or 1 per component.

Sine

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes sine of angles given in degrees. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the sine of each angle component.

Square

• Category: Math / Arithmetic
• Access: All editions.
• Function: Squares the input. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the square of each component.

Square Root

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes the square root; negative inputs yield zero. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the square root where the input is non-negative.

Subtract

• Category: Math / Arithmetic
• Access: All editions.
• Function: Subtracts the second value from the first. The operation is performed element-wise. A single-component operand is broadcast across the other.
• Input pins:
  • ⏺  A (vector) - Minuend.
  • ⏺  B (vector) - Subtrahend.
• Output pins:
  • ⏺  Out (vector) - Carries A minus B.

Tangent

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes tangent of angles given in degrees. The operation is performed element-wise.
• Input pins:
  • ⏺  In (vector) - The source value
• Output pins:
  • ⏺  Out (vector) - Carries the tangent of each angle component.

Unlerp

• Category: Math / Arithmetic
• Access: All editions.
• Function: Computes the blend parameter that maps the input between endpoints A and B (optionally clamping to 0–1). The operation is performed element-wise on the input vector. Endpoints A and B are single-component values broadcast across the input components.
• Input pins:
  • ⏺  In (vector) - The source value
  • ⏺  A (scalar) - Endpoint corresponding to blend parameter 0 (shared across components).
  • ⏺  B (scalar) - Endpoint corresponding to blend parameter 1 (shared across components).
  • ⏺  Clamp (logical) - When on, clamps the output parameter to the range 0–1 after unlerping.
• Output pins:
  • ⏺  Out (vector) - Carries the normalized position of In between A and B.

Math / Arithm Double

This section describes the built-in Flow Graph modules that perform double-precision arithmetic operations on numeric values.

Absolute Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the absolute value (non-negative magnitude) of the input.
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the magnitude of the input.

Add Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Adds two values.
• Input pins:
  • ⏺  A (double precision scalar) - First operand in the sum.
  • ⏺  B (double precision scalar) - Second operand in the sum.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries A plus B.

Angle Normalize Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Wraps a degree angle into a signed range or a single turn.
• Input pins:
  • ⏺  In (double precision scalar) - Angle in degrees to normalize.
  • ⏺  Signed (logical) - When on, maps to [-180°, 180°); when off, maps to [0°, 360°).
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the wrapped angle in degrees.

Arccosine Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs inverse cosine in degrees, clamping the input to between -1 and 1 so the arc is always defined.
• Input pins:
  • ⏺  In (double precision scalar) - Cosine value before inversion; values outside -1…1 are clamped.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the angle in degrees whose cosine equals the clamped input.

Arctangent Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the angle in degrees from Y and X using full-quadrant atan2-style behavior.
• Input pins:
  • ⏺  Y (double precision scalar) - Numerator-like component for the angle (ordinate).
  • ⏺  X (double precision scalar) - Denominator-like component for the angle (abscissa).
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the angle in degrees from the positive X axis to (X, Y).

Arcsine Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs inverse sine in degrees, clamping the input to between -1 and 1 so the arc is always defined.
• Input pins:
  • ⏺  In (double precision scalar) - Sine value before inversion; values outside -1…1 are clamped.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the angle in degrees whose sine equals the clamped input.

Average Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the mean of two values, or a circular midpoint when circular averaging is on.
• Input pins:
  • ⏺  A (double precision scalar) - First value entering the average.
  • ⏺  B (double precision scalar) - Second value entering the average.
  • ⏺  Circular (logical) - When on, averages along a circle using CircularRange as one full turn; when off, uses plain arithmetic mean.
  • ⏺  Circular Range (double precision scalar) - Period for circular mode (length of one full wrap).
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the arithmetic mean or circular midpoint of A and B.

Ceiling Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the smallest integer no less than the input (ceiling).
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the ceiling of the input value.

Clamp Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Constrains a value to a minimum–maximum interval, or wraps inside that interval when circular mode is on.
• Input pins:
  • ⏺  In (double precision scalar) - Value constrained or wrapped.
  • ⏺  Minimum (double precision scalar) - Lower bound of the allowed interval.
  • ⏺  Maximum (double precision scalar) - Upper bound of the allowed interval.
  • ⏺  Circular (logical) - When on, wraps the value within the interval; when off, clamps to Minimum and Maximum.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the clamped or wrapped result.

Cosine Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs cosine of an angle given in degrees.
• Input pins:
  • ⏺  In (double precision scalar) - Angle in degrees.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the cosine of the angle.

Divide Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Divides one value by another, outputting zero when the divisor is zero.
• Input pins:
  • ⏺  A (double precision scalar) - Numerator.
  • ⏺  B (double precision scalar) - Denominator; when zero, the output is zero instead of dividing.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries A divided by B, or zero when B is zero.

Exponential Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs e raised to the input power.
• Input pins:
  • ⏺  In (double precision scalar) - Exponent applied to e.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the natural exponential of the input.

Floor Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the greatest integer no greater than the input (floor).
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the floor of the input value.

Invert Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs one minus the input (flips a normalized 0–1-style control).
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries one minus the input value.

Lerp Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Blends between two values using a blend factor, with optional factor clamping, circular blending, and short-circuiting at exact endpoints.
• Input pins:
  • ⏺  A (double precision scalar) - Value at Factor 0.
  • ⏺  B (double precision scalar) - Value at Factor 1.
  • ⏺  Factor (double precision scalar) - Blend weight; 0 selects A, 1 selects B, values between interpolate.
  • ⏺  Clamp (logical) - When on, restricts Factor to the range 0–1 before blending.
  • ⏺  Circular (logical) - When on, interpolates along a circular path using CircularRange as the period.
  • ⏺  Circular Range (double precision scalar) - Wrap length for circular blending.
  • ⏺  Force Both (logical) - When on, both inputs are pulled continuously; when off, only the active inputs are pulled.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the interpolated value.

Logarithm Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the natural logarithm of the input, or zero when the result would be non-finite.
• Input pins:
  • ⏺  In (double precision scalar) - Argument of the logarithm; non-positive values yield a non-finite log and output zero.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the natural logarithm, or zero when that value would be non-finite.

Maximum Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the larger of two values.
• Input pins:
  • ⏺  A (double precision scalar) - First value compared.
  • ⏺  B (double precision scalar) - Second value compared.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the greater of A and B.

Minimum Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the smaller of two values.
• Input pins:
  • ⏺  A (double precision scalar) - First value compared.
  • ⏺  B (double precision scalar) - Second value compared.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the lesser of A and B.

Modulo Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Wraps a value relative to an optional base along a divisor period, or outputs the base when the divisor is zero.
• Input pins:
  • ⏺  A (double precision scalar) - Value wrapped relative to Base.
  • ⏺  B (double precision scalar) - Divisor period; when zero, the output equals Base.
  • ⏺  Base (double precision scalar) - Reference offset applied before wrapping when B is non-zero.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries Base plus the wrapped remainder of A relative to Base and B when B is non-zero.

Multiply Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Multiplies two values.
• Input pins:
  • ⏺  A (double precision scalar) - First factor.
  • ⏺  B (double precision scalar) - Second factor.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries A times B.

Negate Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the input with opposite sign.
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the negated input.

Power Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Raises one value to the power of another, with optional handling for negative bases and zero when the result is non-finite.
• Input pins:
  • ⏺  A (double precision scalar) - Base raised to the exponent B.
  • ⏺  B (double precision scalar) - Exponent applied to A.
  • ⏺  Symmetric (logical) - When on and A is negative, preserves sign using odd-like powers of the absolute base; when off, uses the standard power function.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the power result, or zero when the result would be non-finite.

Reciprocal Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs one divided by the input, or zero when the input is zero.
• Input pins:
  • ⏺  In (double precision scalar) - Divisor whose reciprocal is taken; zero yields output zero.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the reciprocal when the input is non-zero.

Round Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Rounds the input to the nearest whole number using add-half-then-floor.
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the rounded input value.

Sign Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs -1, 0, or 1 according to whether the input is below, equal to, or above zero.
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the sign of the input as -1, 0, or 1.

Sine Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs sine of an angle given in degrees.
• Input pins:
  • ⏺  In (double precision scalar) - Angle in degrees.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the sine of the angle.

Square Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the input squared.
• Input pins:
  • ⏺  In (double precision scalar) - The source value
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the input multiplied by itself.

Square Root Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs the square root for non-negative inputs and zero for negative inputs.
• Input pins:
  • ⏺  In (double precision scalar) - Radicand; negative values yield output zero.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the square root when the input is non-negative.

Subtract Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Subtracts one value from another.
• Input pins:
  • ⏺  A (double precision scalar) - Minuend.
  • ⏺  B (double precision scalar) - Subtrahend.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries A minus B.

Tangent Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Outputs tangent of an angle given in degrees.
• Input pins:
  • ⏺  In (double precision scalar) - Angle in degrees.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries the tangent of the angle.

Unlerp Double

• Category: Math / Arithm Double
• Access: All editions.
• Function: Computes the blend parameter that maps between two endpoints from a value, optionally clamping to 0–1.
• Input pins:
  • ⏺  In (double precision scalar) - Position along the interval from A to B.
  • ⏺  A (double precision scalar) - Endpoint corresponding to blend parameter 0.
  • ⏺  B (double precision scalar) - Endpoint corresponding to blend parameter 1.
  • ⏺  Clamp (logical) - When on, restricts the output parameter to the range 0–1 after unlerping.
• Output pins:
  • ⏺  Out (double precision scalar) - Carries (In-A)/(B-A) when A and B differ; when they match, 0 if In is at or below that value and 1 otherwise; Clamp optionally limits the result to 0-1 afterward.

Math / Arithm Integer

This section describes the built-in Flow Graph modules that perform integer arithmetic, bitwise operations, and discrete numeric transforms.

Absolute Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs the absolute value of the integer input.
• Input pins:
  • ⏺  In (integer) - The source value
• Output pins:
  • ⏺  Out (integer) - Carries the non-negative magnitude of the input.

Add Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Adds two integers.
• Input pins:
  • ⏺  A (integer) - First term in the sum.
  • ⏺  B (integer) - Second term in the sum.
• Output pins:
  • ⏺  Out (integer) - Carries A plus B.

Clamp Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Constrains an integer to an interval, clamping to the ends or wrapping through it when circular mode is on.
• Input pins:
  • ⏺  In (integer) - Integer value to constrain.
  • ⏺  Minimum (integer) - Lower end of the allowed interval (also used as the wrap span start when circular mode is on).
  • ⏺  Maximum (integer) - Upper end of the allowed interval (open end of the wrap span when circular mode is on).
  • ⏺  Circular (logical) - When on, wraps the value through the interval instead of clamping at the bounds.
• Output pins:
  • ⏺  Out (integer) - Carries the clamped or wrapped result.

Divide Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Divides the first integer by the second with truncating division, outputting zero when the divisor is zero.
• Input pins:
  • ⏺  A (integer) - Dividend (numerator).
  • ⏺  B (integer) - Divisor; when zero, the output is zero instead of dividing.
• Output pins:
  • ⏺  Out (integer) - Carries A divided by B, truncated toward zero.

Invert Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs one minus the input, handy for flipping small integer patterns such as 0 and 1.
• Input pins:
  • ⏺  In (integer) - The source value
• Output pins:
  • ⏺  Out (integer) - Carries 1 minus the input.

Maximum Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs the larger of two integers.
• Input pins:
  • ⏺  A (integer) - First integer to compare.
  • ⏺  B (integer) - Second integer to compare.
• Output pins:
  • ⏺  Out (integer) - Carries whichever of A and B is greater.

Minimum Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs the smaller of two integers.
• Input pins:
  • ⏺  A (integer) - First integer to compare.
  • ⏺  B (integer) - Second integer to compare.
• Output pins:
  • ⏺  Out (integer) - Carries whichever of A and B is smaller.

Modulo Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Reduces A relative to Base over a repeating step B, outputting Base when B is zero.
• Input pins:
  • ⏺  A (integer) - Value reduced into the repeating range.
  • ⏺  B (integer) - Modulus span; when zero, the output equals Base.
  • ⏺  Base (integer) - Offset added to the remainder term; also the output when B is zero.
• Output pins:
  • ⏺  Out (integer) - Carries Base plus the non-negative remainder of (A − Base) modulo B when B is non-zero.

Multiply Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Multiplies two integers.
• Input pins:
  • ⏺  A (integer) - First factor.
  • ⏺  B (integer) - Second factor.
• Output pins:
  • ⏺  Out (integer) - Carries A times B.

Negate Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs the arithmetic negation of the input.
• Input pins:
  • ⏺  In (integer) - The source value
• Output pins:
  • ⏺  Out (integer) - Carries the input with its sign flipped.

Power Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Raises an integer base to an integer exponent; exponent zero yields one and negative exponents yield zero.
• Input pins:
  • ⏺  A (integer) - Base.
  • ⏺  B (integer) - Exponent applied to the base.
• Output pins:
  • ⏺  Out (integer) - Carries A raised to B for positive B, 1 when B is 0, and 0 when B is negative.

Sign Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs −1, 0, or 1 according to whether the input is negative, zero, or positive.
• Input pins:
  • ⏺  In (integer) - The source value
• Output pins:
  • ⏺  Out (integer) - Carries −1 when the input is negative, 0 when it is zero, and 1 when it is positive.

Square Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Outputs the square of the integer input.
• Input pins:
  • ⏺  In (integer) - The source value
• Output pins:
  • ⏺  Out (integer) - Carries the input multiplied by itself.

Subtract Integer

• Category: Math / Arithm Integer
• Access: All editions.
• Function: Subtracts the second integer from the first.
• Input pins:
  • ⏺  A (integer) - Minuend (value to subtract from).
  • ⏺  B (integer) - Subtrahend (value to subtract).
• Output pins:
  • ⏺  Out (integer) - Carries A minus B.