goog.math

Provided By	`goog.math`

Computes the angle between two points (x1,y1) and (x2,y2). Angle zero points in the +X direction, 90 degrees points in the +Y direction (down) and from there we grow clockwise towards 360 degrees.

Parameters

`x1`	`number`
	x of first point.
`y1`	`number`
	y of first point.
`x2`	`number`
	x of second point.
`y2`	`number`
	y of second point.

Returns

number

Standardized angle in degrees of the vector from x1,y1 to x2,y2.

VIEW SOURCE

Computes the difference between startAngle and endAngle (angles in degrees).

Parameters

`startAngle`	`number`
	Start angle in degrees.
`endAngle`	`number`
	End angle in degrees.

Returns

number

The number of degrees that when added to startAngle will result in endAngle. Positive numbers mean that the direction is clockwise. Negative numbers indicate a counter-clockwise direction. The shortest route (clockwise vs counter-clockwise) between the angles is used. When the difference is 180 degrees, the function returns 180 (not -180) angleDifference(30, 40) is 10, and angleDifference(40, 30) is -10. angleDifference(350, 10) is 20, and angleDifference(10, 350) is -20.

VIEW SOURCE

For a given angle and radius, finds the X portion of the offset.

Parameters

`degrees`	`number`
	Angle in degrees (zero points in +X direction).
`radius`	`number`
	Radius.

Returns

number

The x-distance for the angle and radius.

VIEW SOURCE

For a given angle and radius, finds the Y portion of the offset.

Parameters

`degrees`	`number`
	Angle in degrees (zero points in +X direction).
`radius`	`number`
	Radius.

Returns

number

The y-distance for the angle and radius.

VIEW SOURCE

Returns the arithmetic mean of the arguments.

Parameters

`var_args`	`...number`
	Numbers to average.

Returns

number

The average of the arguments (NaN if no arguments were provided or any of the arguments is not a valid number).

VIEW SOURCE

Takes a number and clamps it to within the provided bounds.

Parameters

`value`	`number`
	The input number.
`min`	`number`
	The minimum value to return.
`max`	`number`
	The maximum value to return.

Returns

number

The input number if it is within bounds, or the nearest number within the bounds.

VIEW SOURCE

Returns whether the supplied number is finite and not NaN.

Deprecated	Use `isFinite` instead.

Parameters

`num`	`number`
	The number to test.

Returns

boolean

Whether num is a finite number.

VIEW SOURCE

Returns whether the supplied number represents an integer, i.e. that is has no fractional component. No range-checking is performed on the number.

Parameters

`num`	`number`
	The number to test.

Returns

boolean

Whether num is an integer.

VIEW SOURCE

Parameters

`num`	`number`
	The number to test.

Returns

boolean

Whether it is negative zero.

VIEW SOURCE

Performs linear interpolation between values a and b. Returns the value between a and b proportional to x (when x is between 0 and 1. When x is outside this range, the return value is a linear extrapolation).

Parameters

`a`	`number`
	A number.
`b`	`number`
	A number.
`x`	`number`
	The proportion between a and b.

Returns

number

The interpolated value between a and b.

VIEW SOURCE

Returns the precise value of floor(log10(num)). Simpler implementations didn't work because of floating point rounding errors. For example

Math.floor(Math.log(num) / Math.LN10) is off by one for num == 1e+3.
Math.floor(Math.log(num) * Math.LOG10E) is off by one for num == 1e+15.
Math.floor(Math.log10(num)) is off by one for num == 1e+15 - 1.

Parameters

`num`	`number`
	A floating point number.

Returns

number

Its logarithm to base 10 rounded down to the nearest integer if num > 0. -Infinity if num == 0. NaN if num < 0.

VIEW SOURCE

JavaScript implementation of Longest Common Subsequence problem. http://en.wikipedia.org/wiki/Longest_common_subsequence

Returns the longest possible array that is subarray of both of given arrays.

Parameters

`array1`	`(IArrayLike<(S\|null)>\|null)`
	First array of objects.
`array2`	`(IArrayLike<(T\|null)>\|null)`
	Second array of objects.
`opt_compareFn`	`(Function\|null)=`
	Function that acts as a custom comparator for the array ojects. Function should return true if objects are equal, otherwise false.
`opt_collectorFn`	`(Function\|null)=`
	Function used to decide what to return as a result subsequence. It accepts 2 arguments: index of common element in the first array and index in the second. The default function returns element from the first array.

Returns

Array<(S|null)>

A list of objects that are common to both arrays such that there is no common subsequence with size greater than the length of the list.

VIEW SOURCE

The % operator in JavaScript returns the remainder of a / b, but differs from some other languages in that the result will have the same sign as the dividend. For example, -1 % 8 == -1, whereas in some other languages (such as Python) the result would be 7. This function emulates the more correct modulo behavior, which is useful for certain applications such as calculating an offset index in a circular list.

Parameters

`a`	`number`
	The dividend.
`b`	`number`
	The divisor.

Returns

number

a % b where the result is between 0 and b (either 0 <= x < b or b < x <= 0, depending on the sign of b).

VIEW SOURCE

Tests whether the two values are equal to each other, within a certain tolerance to adjust for floating point errors.

Parameters

`a`	`number`
	A number.
`b`	`number`
	A number.
`opt_tolerance`	`number=`
	Optional tolerance range. Defaults to 0.000001. If specified, should be greater than 0.

Returns

boolean

Whether a and b are nearly equal.

VIEW SOURCE

Returns a random integer greater than or equal to 0 and less than a.

Parameters

`a`	`number`
	The upper bound for the random integer (exclusive).

Returns

number

A random integer N such that 0 <= N < a.

VIEW SOURCE

A tweaked variant of Math.ceil. See goog.math.safeFloor for details.

Parameters

`num`	`number`
	A number.
`opt_epsilon`	`number=`
	An infinitesimally small positive number, the rounding error to tolerate.

Returns

number

The smallest integer greater than or equal to num.

VIEW SOURCE

A tweaked variant of Math.floor which tolerates if the passed number is infinitesimally smaller than the closest integer. It often happens with the results of floating point calculations because of the finite precision of the intermediate results. For example Math.floor(Math.log(1000) / Math.LN10) == 2, not 3 as one would expect.

Parameters

`num`	`number`
	A number.
`opt_epsilon`	`number=`
	An infinitesimally small positive number, the rounding error to tolerate.

Returns

number

The largest integer less than or equal to num.

VIEW SOURCE

Returns the unbiased sample variance of the arguments. For a definition, see e.g. http://en.wikipedia.org/wiki/Variance

Parameters

`var_args`	`...number`
	Number samples to analyze.

Returns

number

The unbiased sample variance of the arguments (0 if fewer than two samples were provided, or NaN if any of the samples is not a valid number).

VIEW SOURCE

Returns the sign of a number as per the "sign" or "signum" function.

Parameters

`x`	`number`
	The number to take the sign of.

Returns

number

-1 when negative, 1 when positive, 0 when 0. Preserves signed zeros and NaN.

VIEW SOURCE

Normalizes an angle to be in range [0-360). Angles outside this range will be normalized to be the equivalent angle with that range.

Parameters

`angle`	`number`
	Angle in degrees.

Returns

number

Standardized angle.

VIEW SOURCE

Normalizes an angle to be in range [0-2*PI). Angles outside this range will be normalized to be the equivalent angle with that range.

Parameters

`angle`	`number`
	Angle in radians.

Returns

number

Standardized angle.

VIEW SOURCE

Returns the sample standard deviation of the arguments. For a definition of sample standard deviation, see e.g. http://en.wikipedia.org/wiki/Standard_deviation

Parameters

`var_args`	`...number`
	Number samples to analyze.

Returns

number

The sample standard deviation of the arguments (0 if fewer than two samples were provided, or NaN if any of the samples is not a valid number).

VIEW SOURCE

Returns the sum of the arguments.

Parameters

`var_args`	`...number`
	Numbers to add.

Returns

number

The sum of the arguments (0 if no arguments were provided, NaN if any of the arguments is not a valid number).

VIEW SOURCE

Converts radians to degrees.

Parameters

`angleRadians`	`number`
	Angle in radians.

Returns

number

Angle in degrees.

VIEW SOURCE

Converts degrees to radians.

Parameters

`angleDegrees`	`number`
	Angle in degrees.

Returns

number

Angle in radians.

VIEW SOURCE

Returns a random number greater than or equal to a and less than b.

Parameters

`a`	`number`
	The lower bound for the random number (inclusive).
`b`	`number`
	The upper bound for the random number (exclusive).

Returns

number

A random number N such that a <= N < b.

VIEW SOURCE

goog.math

Functions

angle( `x1`, `y1`, `x2`, `y2` ) `→` `number`

angleDifference( `startAngle`, `endAngle` ) `→` `number`

angleDx( `degrees`, `radius` ) `→` `number`

angleDy( `degrees`, `radius` ) `→` `number`

average( `...var_args` ) `→` `number`

clamp( `value`, `min`, `max` ) `→` `number`

isFiniteNumber( `num` ) `→` `boolean`

isInt( `num` ) `→` `boolean`

isNegativeZero( `num` ) `→` `boolean`

lerp( `a`, `b`, `x` ) `→` `number`

log10Floor( `num` ) `→` `number`

longestCommonSubsequence`<S, T>`( `array1`, `array2`, `opt_compareFn`, `opt_collectorFn` ) `→` `Array<(S|null)>`

modulo( `a`, `b` ) `→` `number`

nearlyEquals( `a`, `b`, `opt_tolerance` ) `→` `boolean`

randomInt( `a` ) `→` `number`

safeCeil( `num`, `opt_epsilon` ) `→` `number`

safeFloor( `num`, `opt_epsilon` ) `→` `number`

sampleVariance( `...var_args` ) `→` `number`

sign( `x` ) `→` `number`

standardAngle( `angle` ) `→` `number`

standardAngleInRadians( `angle` ) `→` `number`

standardDeviation( `...var_args` ) `→` `number`

sum( `...var_args` ) `→` `number`

toDegrees( `angleRadians` ) `→` `number`

toRadians( `angleDegrees` ) `→` `number`

uniformRandom( `a`, `b` ) `→` `number`

Properties

interpolator `→` `{Interpolator1: function(this: goog.math.interpolator.Interpolator1): ?, Linear1: function(new: goog.math.interpolator.Linear1), Pchip1: function(new: goog.math.interpolator.Pchip1), Spline1: function(new: goog.math.interpolator.Spline1)}`

Interfaces

Classes

goog.math

Functions

angle( x1, y1, x2, y2 ) → number

angleDifference( startAngle, endAngle ) → number

angleDx( degrees, radius ) → number

angleDy( degrees, radius ) → number

average( ...var_args ) → number

clamp( value, min, max ) → number

isFiniteNumber( num ) → boolean

isInt( num ) → boolean

isNegativeZero( num ) → boolean

lerp( a, b, x ) → number

log10Floor( num ) → number

longestCommonSubsequence<S, T>( array1, array2, opt_compareFn, opt_collectorFn ) → Array<(S|null)>

modulo( a, b ) → number

nearlyEquals( a, b, opt_tolerance ) → boolean

randomInt( a ) → number

safeCeil( num, opt_epsilon ) → number

safeFloor( num, opt_epsilon ) → number

sampleVariance( ...var_args ) → number

sign( x ) → number

standardAngle( angle ) → number

standardAngleInRadians( angle ) → number

standardDeviation( ...var_args ) → number

sum( ...var_args ) → number

toDegrees( angleRadians ) → number

toRadians( angleDegrees ) → number

uniformRandom( a, b ) → number

Properties

interpolator → {Interpolator1: function(this: goog.math.interpolator.Interpolator1): ?, Linear1: function(new: goog.math.interpolator.Linear1), Pchip1: function(new: goog.math.interpolator.Pchip1), Spline1: function(new: goog.math.interpolator.Spline1)}

Interfaces

Classes

angle( `x1`, `y1`, `x2`, `y2` ) `→` `number`

angleDifference( `startAngle`, `endAngle` ) `→` `number`

angleDx( `degrees`, `radius` ) `→` `number`

angleDy( `degrees`, `radius` ) `→` `number`

average( `...var_args` ) `→` `number`

clamp( `value`, `min`, `max` ) `→` `number`

isFiniteNumber( `num` ) `→` `boolean`

isInt( `num` ) `→` `boolean`

isNegativeZero( `num` ) `→` `boolean`

lerp( `a`, `b`, `x` ) `→` `number`

log10Floor( `num` ) `→` `number`

longestCommonSubsequence`<S, T>`( `array1`, `array2`, `opt_compareFn`, `opt_collectorFn` ) `→` `Array<(S|null)>`

modulo( `a`, `b` ) `→` `number`

nearlyEquals( `a`, `b`, `opt_tolerance` ) `→` `boolean`

randomInt( `a` ) `→` `number`

safeCeil( `num`, `opt_epsilon` ) `→` `number`

safeFloor( `num`, `opt_epsilon` ) `→` `number`

sampleVariance( `...var_args` ) `→` `number`

sign( `x` ) `→` `number`

standardAngle( `angle` ) `→` `number`

standardAngleInRadians( `angle` ) `→` `number`

standardDeviation( `...var_args` ) `→` `number`

sum( `...var_args` ) `→` `number`

toDegrees( `angleRadians` ) `→` `number`

toRadians( `angleDegrees` ) `→` `number`

uniformRandom( `a`, `b` ) `→` `number`

interpolator `→` `{Interpolator1: function(this: goog.math.interpolator.Interpolator1): ?, Linear1: function(new: goog.math.interpolator.Linear1), Pchip1: function(new: goog.math.interpolator.Pchip1), Spline1: function(new: goog.math.interpolator.Spline1)}`