Namespace Numbers

Sub-modules

• Numbers.Normalise: normalise values
• Numbers.Bipolar: helpers for working with -1...1 bipolar values

Working with scalar values

• Numbers.Normalise: normalise values
• proportion: Scales one scalar by another
• wrap: Wraps a value to be within a range
• flip: Flips a percentage-scale number (eg 1 => 0, 0.5 => 0.5, 0 => 1)

Averaging/rounding

• average: Basic mathematical average
• averageWeighted: Weighted average
• movingAverage: Calculates an average-over-time (movingAverageLight is a coarser, less memory-intensive version)
• movingAverageTimed: Automatically add values at a given rate
• noiseFilter: Noise filter
• round
• quantiseEvery: Rounds a value to the nearest given value

Calculating

• dotProduct
• min, max, minIndex, maxIndex
• total
• relativeDifference: Returns the relative difference from some initial value
• weight Weighs an array of numbers according to their position

Generators/iterators

• count: Generate a set numbers, counting by one
• numericPercent: Generate a range of numbers on the percentage scale of 0-1
• numericRange: Generate a range of numbers
• filter: Filter a generator, only yielding those which are numbers
• linearSpace: Generates series of values between start and end

Clamping:

• clamp: Restrict a number to a given range
• clampIndex: Restrict a number to be within the size of an array

Scaling:

• scale: Scale a value from an input range to an output range. scaler returns a function to scale values.
• scaleClamped: Scale a value from an input range to an output range, clamping so that output range is a hard limit
• scalePercent: Scale input percentage to an output range
• scalePercentages: Scale input percentage to an output percentage range

Interpolate

• interpolate: Interpolate from A to B by a given amount
• interpolateAngle: Interpolate angle
• interpolatorInterval: Interpolate automatically over time
• interpolatorStepped: Interpolate automatically stepwise

Etc

• applyToValues: Applies a function to every key of an object which is a number
• isApprox: True if number is roughly within a range
• isValid: True if input is a number, validNumbers