@basementuniverse/commonjs v1.2.10

common.js

A small library of useful functions

Usage

Node:

const { vec, mat } = require('@basementuniverse/commonjs');

Browser:

<script src="common.js"></script>

Typescript:

import { vec, mat } from '@basementuniverse/commonjs';

Contents

• vec
• mat
• Math
• Array

Classes

Functions

Typedefs

Math

Kind: global class

• Math
  • .floatEquals(a, b, [p]) ⇒ boolean
  • .clamp(a, [min], [max]) ⇒ number
  • .frac(a) ⇒ number
  • .lerp(a, b, i) ⇒ number
  • .unlerp(a, b, i) ⇒ number
  • .blerp(c00, c10, c01, c11, ix, iy) ⇒ number
  • .remap(i, a1, a2, b1, b2) ⇒ number
  • .smoothstep(a, b, i) ⇒ number
  • .radians(degrees) ⇒ number
  • .degrees(radians) ⇒ number
  • .randomBetween(min, max) ⇒ number
  • .randomIntBetween(min, max) ⇒ number
  • .cltRandom([mu], [sigma], [samples]) ⇒ number
  • .cltRandomInt(min, max) ⇒ number
  • .weightedRandom(w) ⇒ number
  • .lerpArray(a, i, [f]) ⇒ number
  • .dot(a, b) ⇒ number
  • .factorial(a) ⇒ number
  • .permutation(n, r) ⇒ number
  • .combination(n, r) ⇒ number

Math.floatEquals(a, b, p) ⇒ boolean

Check if two numbers are approximately equal

Kind: static method of Math
Returns: boolean - True if numbers a and b are approximately equal

Math.clamp(a, min, max) ⇒ number

Clamp a number between min and max

Kind: static method of Math
Returns: number - A clamped number

Math.frac(a) ⇒ number

Get the fractional part of a number

Kind: static method of Math
Returns: number - The fractional part of the number

Math.lerp(a, b, i) ⇒ number

Do a linear interpolation between a and b

Kind: static method of Math
Returns: number - An interpolated value in the interval a, b

Math.unlerp(a, b, i) ⇒ number

Get the position of i between a and b

Kind: static method of Math
Returns: number - The position of i between a and b

Math.blerp(c00, c10, c01, c11, ix, iy) ⇒ number

Do a bilinear interpolation

Kind: static method of Math
Returns: number - A bilinear interpolated value

Math.remap(i, a1, a2, b1, b2) ⇒ number

Re-map a number i from range a1...a2 to b1...b2

Kind: static method of Math

Math.smoothstep(a, b, i) ⇒ number

Do a smooth interpolation between a and b

Kind: static method of Math
Returns: number - An interpolated value in the interval a, b

Math.radians(degrees) ⇒ number

Get an angle in radians

Kind: static method of Math
Returns: number - The angle in radians

Math.degrees(radians) ⇒ number

Get an angle in degrees

Kind: static method of Math
Returns: number - The angle in degrees

Math.randomBetween(min, max) ⇒ number

Get a random float in the interval [min, max)

Kind: static method of Math
Returns: number - A random float in the interval [min, max)

Math.randomIntBetween(min, max) ⇒ number

Get a random integer in the interval min, max

Kind: static method of Math
Returns: number - A random integer in the interval min, max

Math.cltRandom(mu, sigma, samples) ⇒ number

Get a normally-distributed random number

Kind: static method of Math
Returns: number - A normally-distributed random number

Math.cltRandomInt(min, max) ⇒ number

Get a normally-distributed random integer in the interval min, max

Kind: static method of Math
Returns: number - A normally-distributed random integer

Math.weightedRandom(w) ⇒ number

Return a weighted random integer

Kind: static method of Math
Returns: number - An index from w

Math.lerpArray(a, i, f) ⇒ number

Return an interpolated value from an array

Kind: static method of Math
Returns: number - An interpolated value in the interval min(a), max(a)

Math.dot(a, b) ⇒ number

Get the dot product of two vectors

Kind: static method of Math
Returns: number - a ∙ b

Math.factorial(a) ⇒ number

Get the factorial of a number

Kind: static method of Math
Returns: number - a!

Math.permutation(n, r) ⇒ number

Get the number of permutations of r elements from a set of n elements

Kind: static method of Math
Returns: number - nPr

Math.combination(n, r) ⇒ number

Get the number of combinations of r elements from a set of n elements

Kind: static method of Math
Returns: number - nCr

Array

Kind: global class

• Array
  • instance
    • .at(i) ⇒ *
    • .chunk(n) ⇒ Array.<Array.<*>>
    • .shuffle() ⇒ Array.<*>
  • static
    • .times(f, n) ⇒ Array.<*>
    • .range(n) ⇒ Array.<number>
    • .zip(a, b) ⇒ Array.<Array.<*>>

array.at(i) ⇒ *

Return arrayi with positive and negative wrapping

Kind: instance method of Array
Returns: * - An element from the array

array.chunk(n) ⇒ Array.<Array.<*>>

Chop an array into chunks of size n

Kind: instance method of Array
Returns: Array.<Array.<*>> - An array of array chunks

array.shuffle() ⇒ Array.<*>

Randomly shuffle an array in-place

Kind: instance method of Array
Returns: Array.<*> - The shuffled array

Array.times(f, n) ⇒ Array.<*>

Return a new array with length n by calling function f(i) on each element

Kind: static method of Array

Array.range(n) ⇒ Array.<number>

Return an array containing numbers 0->(n - 1)

Kind: static method of Array
Returns: Array.<number> - An array of integers 0->(n - 1)

Array.zip(a, b) ⇒ Array.<Array.<*>>

Zip 2 arrays together, i.e. (1, 2, 3, a, b, c) => [1, a, 2, b, 3, c]

Kind: static method of Array

vec(x, y) ⇒ vec

Create a new vector

Kind: global function
Returns: vec - A new vector

Example (Various ways to initialise a vector)

let a = vec(3, 2);  // (3, 2)
let b = vec(4);     // (4, 4)
let c = vec(a);     // (3, 2)
let d = vec();      // (0, 0)

• vec([x], [y]) ⇒ vec
  • .components(a) ⇒ Array.<number>
  • .ux() ⇒ vec
  • .uy() ⇒ vec
  • .add(a, b) ⇒ vec
  • .mul(a, b) ⇒ vec
  • .sub(a, b) ⇒ vec
  • .len(a) ⇒ number
  • .manhattan(a) ⇒ number
  • .nor(a) ⇒ vec
  • .dot(a, b) ⇒ number
  • .rot(a, r) ⇒ vec
  • .eq(a, b) ⇒ boolean
  • .rad(a) ⇒ number
  • .cpy(a) ⇒ vec
  • .map(a, f) ⇒ vec
  • .str(a, [s]) ⇒ string

vec.components(a) ⇒ Array.<number>

Get the components of a vector as an array

Kind: static method of vec
Returns: Array.<number> - The vector components as an array

vec.ux() ⇒ vec

Return a unit vector (1, 0)

Kind: static method of vec
Returns: vec - A unit vector (1, 0)

vec.uy() ⇒ vec

Return a unit vector (0, 1)

Kind: static method of vec
Returns: vec - A unit vector (0, 1)

vec.add(a, b) ⇒ vec

Add vectors

Kind: static method of vec
Returns: vec - a + b

vec.mul(a, b) ⇒ vec

Scale a vector

Kind: static method of vec
Returns: vec - a * b

vec.sub(a, b) ⇒ vec

Subtract vectors

Kind: static method of vec
Returns: vec - a - b

vec.len(a) ⇒ number

Get the length of a vector

Kind: static method of vec
Returns: number - |a|

vec.manhattan(a) ⇒ number

Get the length of a vector using taxicab geometry

Kind: static method of vec
Returns: number - |a|

vec.nor(a) ⇒ vec

Normalise a vector

Kind: static method of vec
Returns: vec - ^a

vec.dot(a, b) ⇒ number

Get a dot product of vectors

Kind: static method of vec
Returns: number - a ∙ b

vec.rot(a, r) ⇒ vec

Rotate a vector by r radians

Kind: static method of vec
Returns: vec - A rotated vector

vec.eq(a, b) ⇒ boolean

Check if two vectors are equal

Kind: static method of vec
Returns: boolean - True if vectors a and b are equal, false otherwise

vec.rad(a) ⇒ number

Get the angle of a vector

Kind: static method of vec
Returns: number - The angle of vector a in radians

vec.cpy(a) ⇒ vec

Copy a vector

Kind: static method of vec
Returns: vec - A copy of vector a

vec.map(a, f) ⇒ vec

Call a function on each component of a vector and build a new vector from the results

Kind: static method of vec
Returns: vec - Vector a mapped through f

vec.str(a, s) ⇒ string

Convert a vector into a string

Kind: static method of vec
Returns: string - A string representation of the vector

mat(m, n, entries) ⇒ mat

Create a new matrix

Kind: global function
Returns: mat - A new matrix

• mat([m], [n], [entries]) ⇒ mat
  • .identity(n) ⇒ mat
  • .get(a, i, j) ⇒ number
  • .set(a, i, j, v)
  • .row(a, m) ⇒ Array.<number>
  • .col(a, n) ⇒ Array.<number>
  • .add(a, b) ⇒ mat
  • .sub(a, b) ⇒ mat
  • .mul(a, b) ⇒ mat | boolean
  • .scale(a, b) ⇒ mat
  • .trans(a) ⇒ mat
  • .minor(a, i, j) ⇒ mat | boolean
  • .det(a) ⇒ number | boolean
  • .nor(a) ⇒ mat | boolean
  • .adj(a) ⇒ mat
  • .inv(a) ⇒ mat | boolean
  • .eq(a, b) ⇒ boolean
  • .cpy(a) ⇒ mat
  • .map(a, f) ⇒ mat
  • .str(a, [ms], [ns]) ⇒ string

mat.identity(n) ⇒ mat

Get an identity matrix of size n

Kind: static method of mat
Returns: mat - An identity matrix

mat.get(a, i, j) ⇒ number

Get an entry from a matrix

Kind: static method of mat
Returns: number - The value at position (i, j) in matrix a

mat.set(a, i, j, v)

Set an entry of a matrix

Kind: static method of mat

mat.row(a, m) ⇒ Array.<number>

Get a row from a matrix as an array

Kind: static method of mat
Returns: Array.<number> - Row m from matrix a

mat.col(a, n) ⇒ Array.<number>

Get a column from a matrix as an array

Kind: static method of mat
Returns: Array.<number> - Column n from matrix a

mat.add(a, b) ⇒ mat

Add matrices

Kind: static method of mat
Returns: mat - a + b

mat.sub(a, b) ⇒ mat

Subtract matrices

Kind: static method of mat
Returns: mat - a - b

mat.mul(a, b) ⇒ mat | boolean

Multiply matrices

Kind: static method of mat
Returns: mat | boolean - ab or false if the matrices cannot be multiplied

mat.scale(a, b) ⇒ mat

Scale a matrix

Kind: static method of mat
Returns: mat - a * b

mat.trans(a) ⇒ mat

Transpose a matrix

Kind: static method of mat
Returns: mat - A transposed matrix

mat.minor(a, i, j) ⇒ mat | boolean

Get the minor of a matrix

Kind: static method of mat
Returns: mat | boolean - The (i, j) minor of matrix a or false if the matrix is not square

mat.det(a) ⇒ number | boolean

Get the determinant of a matrix

Kind: static method of mat
Returns: number | boolean - |a| or false if the matrix is not square

mat.nor(a) ⇒ mat | boolean

Normalise a matrix

Kind: static method of mat
Returns: mat | boolean - ^a or false if the matrix is not square

mat.adj(a) ⇒ mat

Get the adjugate of a matrix

Kind: static method of mat
Returns: mat - The adjugate of a

mat.inv(a) ⇒ mat | boolean

Get the inverse of a matrix

Kind: static method of mat
Returns: mat | boolean - a^-1 or false if the matrix has no inverse

mat.eq(a, b) ⇒ boolean

Check if two matrices are equal

Kind: static method of mat
Returns: boolean - True if matrices a and b are identical, false otherwise

mat.cpy(a) ⇒ mat

Copy a matrix

Kind: static method of mat
Returns: mat - A copy of matrix a

mat.map(a, f) ⇒ mat

Call a function on each entry of a matrix and build a new matrix from the results

Kind: static method of mat
Returns: mat - Matrix a mapped through f

mat.str(a, ms, ns) ⇒ string

Convert a matrix into a string

Kind: static method of mat
Returns: string - A string representation of the matrix

interpolationCallback ⇒ number

An interpolation function

Kind: global typedef
Returns: number - The interpolated value in the interval a, b

timesCallback ⇒ *

A function for generating array values

Kind: global typedef
Returns: * - The array value

vec : Object

A 2d vector

Kind: global typedef
Properties

• vec : Object
  • .components(a) ⇒ Array.<number>
  • .ux() ⇒ vec
  • .uy() ⇒ vec
  • .add(a, b) ⇒ vec
  • .mul(a, b) ⇒ vec
  • .sub(a, b) ⇒ vec
  • .len(a) ⇒ number
  • .manhattan(a) ⇒ number
  • .nor(a) ⇒ vec
  • .dot(a, b) ⇒ number
  • .rot(a, r) ⇒ vec
  • .eq(a, b) ⇒ boolean
  • .rad(a) ⇒ number
  • .cpy(a) ⇒ vec
  • .map(a, f) ⇒ vec
  • .str(a, [s]) ⇒ string

vec.components(a) ⇒ Array.<number>

Get the components of a vector as an array

Kind: static method of vec
Returns: Array.<number> - The vector components as an array

vec.ux() ⇒ vec

Return a unit vector (1, 0)

Kind: static method of vec
Returns: vec - A unit vector (1, 0)

vec.uy() ⇒ vec

Return a unit vector (0, 1)

Kind: static method of vec
Returns: vec - A unit vector (0, 1)

vec.add(a, b) ⇒ vec

Add vectors

Kind: static method of vec
Returns: vec - a + b

vec.mul(a, b) ⇒ vec

Scale a vector

Kind: static method of vec
Returns: vec - a * b

vec.sub(a, b) ⇒ vec

Subtract vectors

Kind: static method of vec
Returns: vec - a - b

vec.len(a) ⇒ number

Get the length of a vector

Kind: static method of vec
Returns: number - |a|

vec.manhattan(a) ⇒ number

Get the length of a vector using taxicab geometry

Kind: static method of vec
Returns: number - |a|

vec.nor(a) ⇒ vec

Normalise a vector

Kind: static method of vec
Returns: vec - ^a

vec.dot(a, b) ⇒ number

Get a dot product of vectors

Kind: static method of vec
Returns: number - a ∙ b

vec.rot(a, r) ⇒ vec

Rotate a vector by r radians

Kind: static method of vec
Returns: vec - A rotated vector

vec.eq(a, b) ⇒ boolean

Check if two vectors are equal

Kind: static method of vec
Returns: boolean - True if vectors a and b are equal, false otherwise

vec.rad(a) ⇒ number

Get the angle of a vector

Kind: static method of vec
Returns: number - The angle of vector a in radians

vec.cpy(a) ⇒ vec

Copy a vector

Kind: static method of vec
Returns: vec - A copy of vector a

vec.map(a, f) ⇒ vec

Call a function on each component of a vector and build a new vector from the results

Kind: static method of vec
Returns: vec - Vector a mapped through f

vec.str(a, s) ⇒ string

Convert a vector into a string

Kind: static method of vec
Returns: string - A string representation of the vector

vectorMapCallback ⇒ number

A function to call on each component of a vector

Kind: global typedef
Returns: number - The mapped component

mat : Object

A matrix

Kind: global typedef
Properties

• mat : Object
  • .identity(n) ⇒ mat
  • .get(a, i, j) ⇒ number
  • .set(a, i, j, v)
  • .row(a, m) ⇒ Array.<number>
  • .col(a, n) ⇒ Array.<number>
  • .add(a, b) ⇒ mat
  • .sub(a, b) ⇒ mat
  • .mul(a, b) ⇒ mat | boolean
  • .scale(a, b) ⇒ mat
  • .trans(a) ⇒ mat
  • .minor(a, i, j) ⇒ mat | boolean
  • .det(a) ⇒ number | boolean
  • .nor(a) ⇒ mat | boolean
  • .adj(a) ⇒ mat
  • .inv(a) ⇒ mat | boolean
  • .eq(a, b) ⇒ boolean
  • .cpy(a) ⇒ mat
  • .map(a, f) ⇒ mat
  • .str(a, [ms], [ns]) ⇒ string

mat.identity(n) ⇒ mat

Get an identity matrix of size n

Kind: static method of mat
Returns: mat - An identity matrix

mat.get(a, i, j) ⇒ number

Get an entry from a matrix

Kind: static method of mat
Returns: number - The value at position (i, j) in matrix a

mat.set(a, i, j, v)

Set an entry of a matrix

Kind: static method of mat

mat.row(a, m) ⇒ Array.<number>

Get a row from a matrix as an array

Kind: static method of mat
Returns: Array.<number> - Row m from matrix a

mat.col(a, n) ⇒ Array.<number>

Get a column from a matrix as an array

Kind: static method of mat
Returns: Array.<number> - Column n from matrix a

mat.add(a, b) ⇒ mat

Add matrices

Kind: static method of mat
Returns: mat - a + b

mat.sub(a, b) ⇒ mat

Subtract matrices

Kind: static method of mat
Returns: mat - a - b

mat.mul(a, b) ⇒ mat | boolean

Multiply matrices

Kind: static method of mat
Returns: mat | boolean - ab or false if the matrices cannot be multiplied

mat.scale(a, b) ⇒ mat

Scale a matrix

Kind: static method of mat
Returns: mat - a * b

mat.trans(a) ⇒ mat

Transpose a matrix

Kind: static method of mat
Returns: mat - A transposed matrix

mat.minor(a, i, j) ⇒ mat | boolean

Get the minor of a matrix

Kind: static method of mat
Returns: mat | boolean - The (i, j) minor of matrix a or false if the matrix is not square

mat.det(a) ⇒ number | boolean

Get the determinant of a matrix

Kind: static method of mat
Returns: number | boolean - |a| or false if the matrix is not square

mat.nor(a) ⇒ mat | boolean

Normalise a matrix

Kind: static method of mat
Returns: mat | boolean - ^a or false if the matrix is not square

mat.adj(a) ⇒ mat

Get the adjugate of a matrix

Kind: static method of mat
Returns: mat - The adjugate of a

mat.inv(a) ⇒ mat | boolean

Get the inverse of a matrix

Kind: static method of mat
Returns: mat | boolean - a^-1 or false if the matrix has no inverse

mat.eq(a, b) ⇒ boolean

Check if two matrices are equal

Kind: static method of mat
Returns: boolean - True if matrices a and b are identical, false otherwise

mat.cpy(a) ⇒ mat

Copy a matrix

Kind: static method of mat
Returns: mat - A copy of matrix a

mat.map(a, f) ⇒ mat

Call a function on each entry of a matrix and build a new matrix from the results

Kind: static method of mat
Returns: mat - Matrix a mapped through f

mat.str(a, ms, ns) ⇒ string

Convert a matrix into a string

Kind: static method of mat
Returns: string - A string representation of the matrix

matrixMapCallback ⇒ number

A function to call on each entry of a matrix

Kind: global typedef
Returns: number - The mapped entry