JSDoc: Namespace: fn

A collection of useful functions.

Source:

syngen/fn.js, line 5

Methods

(static) addInterval(frequency, interval)

Adds a musical interval to a frequency, in Hertz.

Parameters:

Name	Type	Description
`frequency`	Number
`interval`	Number	Each integer multiple represents an octave. For example, `2` raises the frequency by two octaves. Likewise, `-1/12` lowers by one half-step, whereas `-1/100` lowers by one cent.

Source:

syngen/fn.js, line 73

(static) between(value, a, b) → {Boolean}

Returns whether value is between a and b (inclusive).

Parameters:

Name	Type	Description
`value`	Number
`a`	Number
`b`	Number

Source:

syngen/fn.js, line 83

Returns:

Type: Boolean

(static) centroid() → {syngen.utility.vector3d}

Calculates the geometric center of variadic vectors or vector-likes.

Parameters:

Name	Type	Description
`...ectors`	Array.<syngen.utility.vector3d> \| Array.<syngen.utility.vector2d> \| Array.<Object>

Source:

syngen/fn.js, line 91

Returns:

Type: syngen.utility.vector3d

(static) choose(options, valueopt) → {*}

Returns the element of options at the index determined by percentage value.

Parameters:

Name	Type	Attributes	Default	Description
`options`	Array
`value`	Number	<optional>	0	Float within `[0, 1]`.

Source:

syngen/fn.js, line 121

Returns:

Type: *

(static) chooseSplice(options, valueopt) → {*}

Splices and returns the element of options at the index determined by percentage value. Beward that this mutates the passed array.

Parameters:

Name	Type	Attributes	Default	Description
`options`	Array
`value`	Number	<optional>	0	Float within `[0, 1]`.

Source:

syngen/fn.js, line 137

Returns:

Type: *

(static) chooseWeighted(options, valueopt) → {*}

Returns the element of options at the index determined by weighted percentage value.

Parameters:

Name	Type	Attributes	Default	Description
`options`	Array			Each element is expected to have a `weight` key which is a positive number. Higher weights are more likely to be chosen. Beware that elements are not sorted by weight before selection.
`value`	Number	<optional>	0	Float within `[0, 1]`.

Source:

syngen/fn.js, line 155

Returns:

Type: *

(static) clamp(value, minopt, maxopt) → {Number}

Returns value clamped between min and max.

Parameters:

Name	Type	Attributes	Default
`value`	Number
`min`	Number	<optional>	0
`max`	Number	<optional>	1

Source:

syngen/fn.js, line 182

Returns:

Type: Number

(static) closer(x, a, b) → {Number}

Returns whichever value, a or b, that is closer to x.

Parameters:

Name	Type	Description
`x`	Number
`a`	Number
`b`	Number

Source:

syngen/fn.js, line 202

Returns:

Type: Number

(static) closest(x, values) → {Number}

Returns the closest value to x in the array values.

Parameters:

Name	Type	Description
`x`	Number
`values`	Array.<Number>

Source:

syngen/fn.js, line 214

To Do:

Improve performance with a version for pre-sorted arrays

Returns:

Type: Number

(static) createNoise(options) → {Object}

Instantiates octaves noise generators of type with seed and returns a wrapper object that calculates their combined values.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`noScale`	Number	<optional>	[]	Indices of arguments to not scale by frequency for higher octaves.
`octaves`	Number	<optional>	1
`seed`	*
`type`	String			Valid values include `1d`, `perlin2d`, `perlin3d`, `perlin4d`, `simplex2d`, `simplex3d`, `simplex4d`.

Source:

syngen/fn.js, line 231

To Do:

noScale option needs a better name?

Returns:

Type: Object

(static) debounced(fn, timeoutopt) → {function}

Returns a debounced version of fn that executes timeout milliseconds after its last execution.

Parameters:

Name	Type	Attributes	Default	Description
`fn`	function
`timeout`	Number	<optional>	0

Source:

syngen/fn.js, line 326

Returns:

Type: function

(static) deg2rad(degrees) → {Number}

Converts degrees to radians.

Parameters:

Name	Type	Description
`degrees`	Number

Source:

syngen/fn.js, line 318

Returns:

Type: Number

(static) detune(frequency, centsopt) → {Number}

Adds a musical interval to frequency in cents.

Parameters:

Name	Type	Attributes	Default	Description
`frequency`	Number
`cents`	Number	<optional>	0	Every 1200 represents an octave. For example, `2400` raises the frequency by two octaves. Likewise, `-100` lowers by one half-step, whereas `-1` lowers by one cent.

Source:

syngen/fn.js, line 345

Returns:

Type: Number

(static) distance(a, b) → {Number}

Calculates the distance between two vectors or vector-likes.

Parameters:

Name	Type	Description
`a`	syngen.tool.vector2d \| syngen.tool.vector3d \| Object
`b`	syngen.tool.vector2d \| syngen.tool.vector3d \| Object

Source:

syngen/fn.js, line 354

Returns:

Type: Number

(static) distance2(a, b) → {Number}

Calculates the squared distance between two vectors or vector-likes.

Parameters:

Name	Type	Description
`a`	syngen.tool.vector2d \| syngen.tool.vector3d \| Object
`b`	syngen.tool.vector2d \| syngen.tool.vector3d \| Object

Source:

syngen/fn.js, line 363

Returns:

Type: Number

(static) extend(prototype, definition) → {Object}

Creates a shallow copy of definition which has prototype. If definition is a function, it will be executed with prototype as its argument.

Parameters:

Name	Type	Description
`prototype`	Object
`definition`	Object \| function

Source:

syngen/fn.js, line 381

Returns:

Type: Object

(static) fromDb(decibels) → {Number}

Converts decibels to its equivalent gain value.

Parameters:

Name	Type	Description
`decibels`	Number

Source:

syngen/fn.js, line 395

Returns:

Type: Number

(static) fromMidi(note) → {Number}

Converts a MIDI note number to its frequency, in Hertz.

Parameters:

Name	Type	Description
`note`	Number

Source:

syngen/fn.js, line 405

See:

Returns:

Type: Number

(static) hash(value) → {Number}

Converts value to an integer via the Jenkins hash function.

Parameters:

Name	Type	Description
`value`	String

Source:

syngen/fn.js, line 415

Returns:

Type: Number

(static) holdParam(audioParam)

Holds audioParam at its current time and cancels future values. This is a polyfill for AudioParam.cancelAndHoldAtTime().

Parameters:

Name	Type	Description
`audioParam`	AudioParam

Source:

syngen/fn.js, line 440

(static) humanize(baseValue, amount) → {Number}

Adds a random value to baseValue within the range of negative to positive amount.

Parameters:

Name	Type	Description
`baseValue`	Number
`amount`	Number

Source:

syngen/fn.js, line 453

Returns:

Type: Number

(static) humanizeDb(baseGain, decibels) → {Number}

Adds a random gain to baseGain within the range of negative to positive decibels, first converted to gain.

Parameters:

Name	Type	Description
`baseGain`	Number
`decibels`	Number

Source:

syngen/fn.js, line 464

Returns:

Type: Number

(static) intersects(a, b) → {Boolean}

Returns whether rectangular prisms a and b intersect. A rectangular prism has a bottom-left vertex with coordinates (x, y, z) and width, height, and depth along those axes respectively. An intersection occurs if their faces intersect, they share vertices, or one is contained within the other. This function works for one- and two-dimensional shapes as well.

Parameters:

Name	Type	Description
`a`	Object
`b`	Object

Source:

syngen/fn.js, line 480

To Do:

Define a rectangular prism utility or type

Returns:

Type: Boolean

(static) lerp(min, max, valueopt) → {Number}

Linearly interpolates between min and max with value.

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number
`max`	Number
`value`	Number	<optional>	0	Float within `[0, 1]`.

Source:

syngen/fn.js, line 518

Returns:

Type: Number

(static) lerpExp(min, max, valueopt, poweropt) → {Number}

Linearly interpolates between min and max with value raised to power.

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number
`max`	Number
`value`	Number	<optional>	0	Float within `[0, 1]`.
`power`	Number	<optional>	2

Source:

syngen/fn.js, line 530

Returns:

Type: Number

(static) lerpExpRandom(lowRange, highRange, valueopt, poweropt) → {Number}

Returns a random value within the range where the lower bound is the interpolated value within [lowMin, highMin], the upper bound is the interpolated value within [lowMax, highMax]. Values are interpolated with lerpExpRandom.

Parameters:

Name	Type	Attributes	Description
`lowRange`	Array.<Number>		Expects `[lowMin, lowMax]`.
`highRange`	Array.<Number>		Expects `[highMin, highMax]`.
`value`	Number	<optional>
`power`	Number	<optional>

Source:

syngen/fn.js, line 547

See:

syngen.fn.lerpExp

Returns:

Type: Number

(static) lerpLog(min, max, valueopt, baseopt) → {Number}

Linearly interpolates between min and max with value logarithmically with base.

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number
`max`	Number
`value`	Number	<optional>	0	Float within `[0, 1]`.
`base`	Number	<optional>	2

Source:

syngen/fn.js, line 564

Returns:

Type: Number

(static) lerpLogi(min, max, valueopt, baseopt) → {Number}

Linearly interpolates between min and max with value logarithmically with base. This function is shorthand for lerpLog(min, max, 1 - value, 1 / base) which results in curve that inversely favors larger values. This is similar to but distinct from lerpExp.

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number
`max`	Number
`value`	Number	<optional>	0	Float within `[0, 1]`.
`base`	Number	<optional>	2

Source:

syngen/fn.js, line 582

See:

syngen.fn.lerpLog

Returns:

Type: Number

(static) lerpLogiRandom(lowRange, highRange, valueopt, poweropt) → {Number}

Parameters:

Name	Type	Attributes	Description
`lowRange`	Array.<Number>		Expects `[lowMin, lowMax]`.
`highRange`	Array.<Number>		Expects `[highMin, highMax]`.
`value`	Number	<optional>
`power`	Number	<optional>

Source:

syngen/fn.js, line 599

See:

syngen.fn.lerpLogi

Returns:

Type: Number

(static) lerpLogRandom(lowRange, highRange, valueopt, baseopt) → {Number}

Parameters:

Name	Type	Attributes	Description
`lowRange`	Array.<Number>		Expects `[lowMin, lowMax]`.
`highRange`	Array.<Number>		Expects `[highMin, highMax]`.
`value`	Number	<optional>
`base`	Number	<optional>

Source:

syngen/fn.js, line 619

See:

syngen.fn.lerpLog

Returns:

Type: Number

(static) lerpRandom(lowRange, highRange, valueopt, baseopt) → {Number}

Parameters:

Name	Type	Attributes	Description
`lowRange`	Array.<Number>		Expects `[lowMin, lowMax]`.
`highRange`	Array.<Number>		Expects `[highMin, highMax]`.
`value`	Number	<optional>
`base`	Number	<optional>

Source:

syngen/fn.js, line 639

See:

syngen.fn.lerp

Returns:

Type: Number

(static) normalizeAngle(angle) → {Number}

Normalizes angle within therange of [0, 2π].

Parameters:

Name	Type	Description
`angle`	Number

Source:

syngen/fn.js, line 652

Returns:

Type: Number

(static) normalizeAngleSigned(angle) → {Number}

Normalizes angle within the range of [-π, +π].

Parameters:

Name	Type	Description
`angle`	Number

Source:

syngen/fn.js, line 671

Returns:

Type: Number

(static) promise(durationopt) → {Promise}

Returns a cancelable promise that resolves after duration milliseconds.

Parameters:

Name	Type	Attributes	Default	Description
`duration`	Number	<optional>	0

Source:

syngen/fn.js, line 682

Returns:

Has a cancel method that can reject itself prematurely.

Type: Promise

(static) quadratic(a, b, c) → {Array.<Number>}

Calculates the real solutions to the quadratic equation with coefficients a, b, and c.

Parameters:

Name	Type	Description
`a`	Number
`b`	Number
`c`	Number

Source:

syngen/fn.js, line 718

Returns:

Contains only real solutions. May be empty.

Type: Array.<Number>

(static) rad2deg(radians) → {Number}

Converts radians to degrees.

Parameters:

Name	Type	Description
`radians`	Number

Source:

syngen/fn.js, line 731

Returns:

Type: Number

(static) rampCurve(audioParam, curve, durationopt)

Ramps audioParam to the values in curve over duration seconds.

Parameters:

Name	Type	Attributes	Default
`audioParam`	AudioParam
`curve`	Array.<Number>
`duration`	Number	<optional>	`syngen.const.zeroTime`

Source:

syngen/fn.js, line 740

(static) rampExp(audioParam, value, durationopt)

Exponentially ramps audioParam to value over duration seconds.

Parameters:

Name	Type	Attributes	Default
`audioParam`	AudioParam
`value`	Number
`duration`	Number	<optional>	`syngen.const.zeroTime`

Source:

syngen/fn.js, line 753

(static) rampLinear(audioParam, value, durationopt)

Linearly ramps audioParam to value over duration seconds.

Parameters:

Name	Type	Attributes	Default
`audioParam`	AudioParam
`value`	Number
`duration`	Number	<optional>	`syngen.const.zeroTime`

Source:

syngen/fn.js, line 766

(static) randomFloat(minopt, maxopt) → {Number}

Returns a random float between min and max.

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number	<optional>	0
`max`	Number	<optional>	1

Source:

syngen/fn.js, line 779

Returns:

Type: Number

(static) randomInt(minopt, maxopt) → {Number}

Returns a random integer between min and max.

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number	<optional>	0
`max`	Number	<optional>	1

Source:

syngen/fn.js, line 790

Returns:

Type: Number

(static) randomKey(bag) → {String}

Returns a random key in bag.

Parameters:

Name	Type	Description
`bag`	Array \| Map \| Object

Source:

syngen/fn.js, line 809

Returns:

Type: String

(static) randomSign() → {Number}

Returns a random sign as a positive or negative 1.

Source:

syngen/fn.js, line 801

Returns:

Type: Number

(static) randomValue(bag) → {*}

Returns a random value in bag.

Parameters:

Name	Type	Description
`bag`	Array \| Map \| Object \| Set

Source:

syngen/fn.js, line 825

Returns:

Type: *

(static) regularPolygonInteriorAngle(sides) → {Number}

Calculates the interior angle of a regular polygon with sides.

Parameters:

Name	Type	Description
`sides`	Number

Source:

syngen/fn.js, line 845

Returns:

Type: Number

(static) round(value, precision) → {Number}

Rounds value to precision places. Beward that precision is an inverse power of ten. For example, 3 rounds to the nearest thousandth, whereas -3 rounds to the nearest thousand.

Parameters:

Name	Type	Description
`value`	Number
`precision`	Number

Source:

syngen/fn.js, line 856

Returns:

Type: Number

(static) scale(value, min, max, a, b) → {Number}

Scales value within the range [min, max] to an equivalent value between [a, b].

Parameters:

Name	Type	Description
`value`	Number
`min`	Number
`max`	Number
`a`	Number
`b`	Number

Source:

syngen/fn.js, line 871

Returns:

Type: Number

(static) setParam(audioParam, value)

Sets audioParam to value without pops or clicks. The duration depends on the average frame rate.

Parameters:

Name	Type	Description
`audioParam`	AudioParam
`value`	Number

Source:

syngen/fn.js, line 881

See:

syngen.performance.delta

(static) shuffle(array, randomopt)

Returns a shuffled shallow copy of array using random algorithm. For example, implementations could leverage srand() to produce the same results each time given the same seed value.

Parameters:

Name	Type	Attributes	Default	Description
`array`	Array
`random`	function	<optional>	Math.random

Source:

syngen/fn.js, line 893

(static) smooth(value, slopeopt) → {Number}

Implementation of the generalized logistic function with configurable slope.

Parameters:

Name	Type	Attributes	Default	Description
`value`	Number
`slope`	Number	<optional>	25

Source:

syngen/fn.js, line 911

Returns:

Type: Number

(static) srand() → {syngen.fn.srandGenerator}

Returns a pseudo-random, linear congruential, seeded random number generator with variadic seeds. Seeds are prepended with the global syngen.seed and concatenated with syngen.const.seedSeparator.

Parameters:

Name	Type	Attributes	Description
`...seeds`	String	<optional> <repeatable>

Source:

syngen/fn.js, line 923

Returns:

Type: syngen.fn.srandGenerator

(static) toCents(a, b) → {Number}

Calculates the musical interval between two frequencies, in cents.

Parameters:

Name	Type	Description
`a`	Number
`b`	Number

Source:

syngen/fn.js, line 959

Returns:

Type: Number

(static) toDb(gain) → {Number}

Converts gain to its equivalent decibel value.

Parameters:

Name	Type	Description
`gain`	Number

Source:

syngen/fn.js, line 967

Returns:

Type: Number

(static) toMidi(frequency) → {Number}

Converts frequency, in Hertz, to its corresponding MIDI note number. The returned value is not rounded.

Parameters:

Name	Type	Description
`frequency`	Number

Source:

syngen/fn.js, line 978

See:

Returns:

Type: Number

(static) transpose(frequency, minopt, maxopt) → {Number}

Scales frequency by integer multiples so it's between min and max.

Parameters:

Name	Type	Attributes	Default
`frequency`	Number
`min`	Number	<optional>	`syngen.const.minFrequency`
`max`	Number	<optional>	`syngen.const.maxFrequency`

Source:

syngen/fn.js, line 988

Returns:

Type: Number

(static) uuid() → {String}

Generates a universally unique identifier.

Source:

syngen/fn.js, line 1005

Returns:

Type: String

(static) wrap(value, minopt, maxopt) → {Number}

Wraps value around the range [min, max) with modular arithmetic. Beware that min is congruent to max, so returned values will approach the limit of max before wrapping back to min. A way to visualize this operation is that the range repeats along the number line.

Parameters:

Name	Type	Attributes	Default
`value`	Number
`min`	Number	<optional>	0
`max`	Number	<optional>	1

Source:

syngen/fn.js, line 1022

Returns:

Type: Number

(static) wrapAlternate(value, minopt, maxopt) → {Number}

Maps value to an alternating oscillation of the range [min, max]. A way to visualize this operation is that the range repeats alternately along the number line, such that min goes to max back to min.

Parameters:

Name	Type	Attributes	Default
`value`	Number
`min`	Number	<optional>	0
`max`	Number	<optional>	1

Source:

syngen/fn.js, line 1045

Returns:

Type: Number

Type Definitions

srandGenerator(minopt, maxopt) → {Number}

A pseudo-random, linear congruential, seeded random number generator that returns a value within [min, max].

Parameters:

Name	Type	Attributes	Default	Description
`min`	Number	<optional>	0
`max`	Number	<optional>	1

Source:

syngen/fn.js, line 935

See:

syngen.fn.srand

Returns:

Type: Number