JsDoc: Math

Overview

Math Utility functions

Timeplot.Math.range(f)

Evaluates the range (min and max values) of the given array

parameters

f

Timeplot.Math.movingAverage(f, size)

Evaluates the windows average of a given array based on the given window size

parameters

	f
	size

Timeplot.Math.integral(f)

Returns an array with the integral of the given array

parameters

f

Timeplot.Math.normalize(f)

Normalizes an array so that its complete integral is 1. This is useful to obtain arrays that preserve the overall integral of a convolution.

parameters

f

Timeplot.Math.convolution(f, g)

Calculates the convolution between two arrays

parameters

	f
	g

Timeplot.Math.heavyside(size)

Generate the heavyside step function of given size

parameters

size

Timeplot.Math.gaussian(size, threshold)

Generate the gaussian function so that at the given 'size' it has value 'threshold' and make sure its integral is one.

parameters

	size
	threshold

Timeplot.Math.round(x, n)

Return x with n significant figures

parameters

	x
	n

Timeplot.Math.tanh(x)

Return the hyperbolic tangent of x

parameters

x

Timeplot.Math.isClose(a, b, value)

Returns true if |a.x - b.x| < value && | a.y - b.y | < value

parameters