math

Documentation

Index

• Constants
• func Abs(_ context.Context, args ...core.Value) (core.Value, error)
• func Acos(_ context.Context, args ...core.Value) (core.Value, error)
• func Asin(_ context.Context, args ...core.Value) (core.Value, error)
• func Atan(_ context.Context, args ...core.Value) (core.Value, error)
• func Atan2(_ context.Context, args ...core.Value) (core.Value, error)
• func Average(_ context.Context, args ...core.Value) (core.Value, error)
• func Ceil(_ context.Context, args ...core.Value) (core.Value, error)
• func Cos(_ context.Context, args ...core.Value) (core.Value, error)
• func Degrees(_ context.Context, args ...core.Value) (core.Value, error)
• func Exp(_ context.Context, args ...core.Value) (core.Value, error)
• func Exp2(_ context.Context, args ...core.Value) (core.Value, error)
• func Floor(_ context.Context, args ...core.Value) (core.Value, error)
• func Log(_ context.Context, args ...core.Value) (core.Value, error)
• func Log10(_ context.Context, args ...core.Value) (core.Value, error)
• func Log2(_ context.Context, args ...core.Value) (core.Value, error)
• func Max(_ context.Context, args ...core.Value) (core.Value, error)
• func Median(_ context.Context, args ...core.Value) (core.Value, error)
• func Min(_ context.Context, args ...core.Value) (core.Value, error)
• func Percentile(_ context.Context, args ...core.Value) (core.Value, error)
• func Pi(_ context.Context, args ...core.Value) (core.Value, error)
• func PopulationVariance(_ context.Context, args ...core.Value) (core.Value, error)
• func Pow(_ context.Context, args ...core.Value) (core.Value, error)
• func Radians(_ context.Context, args ...core.Value) (core.Value, error)
• func Rand(_ context.Context, args ...core.Value) (core.Value, error)
• func Range(_ context.Context, args ...core.Value) (core.Value, error)
• func RegisterLib(ns core.Namespace) error
• func Round(_ context.Context, args ...core.Value) (core.Value, error)
• func SampleVariance(_ context.Context, args ...core.Value) (core.Value, error)
• func Sin(_ context.Context, args ...core.Value) (core.Value, error)
• func Sqrt(_ context.Context, args ...core.Value) (core.Value, error)
• func StandardDeviationPopulation(_ context.Context, args ...core.Value) (core.Value, error)
• func StandardDeviationSample(_ context.Context, args ...core.Value) (core.Value, error)
• func Sum(_ context.Context, args ...core.Value) (core.Value, error)
• func Tan(_ context.Context, args ...core.Value) (core.Value, error)

Constants

const (
	RadToDeg  = 180 / math.Pi
	DegToRad  = math.Pi / 180
	RadToGrad = 200 / math.Pi
	GradToDeg = math.Pi / 200
)

Functions

func Abs

func Abs(_ context.Context, args ...core.Value) (core.Value, error)

ABS returns the absolute value of a given number. @param {Int | Float} number - Input number. @return {Float} - The absolute value of a given number.

func Acos

func Acos(_ context.Context, args ...core.Value) (core.Value, error)

ACOS returns the arccosine, in radians, of a given number. @param {Int | Float} number - Input number. @return {Float} - The arccosine, in radians, of a given number.

func Asin

func Asin(_ context.Context, args ...core.Value) (core.Value, error)

ASIN returns the arcsine, in radians, of a given number. @param {Int | Float} number - Input number. @return {Float} - The arcsine, in radians, of a given number.

func Atan

func Atan(_ context.Context, args ...core.Value) (core.Value, error)

ATAN returns the arctangent, in radians, of a given number. @param {Int | Float} number - Input number. @return {Float} - The arctangent, in radians, of a given number.

func Atan2

func Atan2(_ context.Context, args ...core.Value) (core.Value, error)

ATAN2 returns the arc tangent of y/x, using the signs of the two to determine the quadrant of the return value. @param {Int | Float} number1 - Input number. @param {Int | Float} number2 - Input number. @return {Float} - The arc tangent of y/x, using the signs of the two to determine the quadrant of the return value.

func Average

func Average(_ context.Context, args ...core.Value) (core.Value, error)

AVERAGE Returns the average (arithmetic mean) of the values in array. @param {Int[] | Float[]} array - Array of numbers. @return {Float} - The average of the values in array.

func Ceil

func Ceil(_ context.Context, args ...core.Value) (core.Value, error)

CEIL returns the least integer value greater than or equal to a given value. @param {Int | Float} number - Input number. @return {Int} - The least integer value greater than or equal to a given value.

func Cos

func Cos(_ context.Context, args ...core.Value) (core.Value, error)

COS returns the cosine of a given number. @param {Int | Float} number - Input number. @return {Float} - The cosine of a given number.

func Degrees

func Degrees(_ context.Context, args ...core.Value) (core.Value, error)

DEGREES returns the angle converted from radians to degrees. @param {Int | Float} number - The input number. @return {Float} - The angle in degrees

func Exp

func Exp(_ context.Context, args ...core.Value) (core.Value, error)

EXP returns Euler's constant (2.71828...) raised to the power of value. @param {Int | Float} number - Input number. @return {Float} - Euler's constant raised to the power of value.

func Exp2

func Exp2(_ context.Context, args ...core.Value) (core.Value, error)

EXP2 returns 2 raised to the power of value. @param {Int | Float} number - Input number. @return {Float} - 2 raised to the power of value.

func Floor

func Floor(_ context.Context, args ...core.Value) (core.Value, error)

FLOOR returns the greatest integer value less than or equal to a given value. @param {Int | Float} number - Input number. @return {Int} - The greatest integer value less than or equal to a given value.

func Log

func Log(_ context.Context, args ...core.Value) (core.Value, error)

LOG returns the natural logarithm of a given value. @param {Int | Float} number - Input number. @return {Float} - The natural logarithm of a given value.

func Log10

func Log10(_ context.Context, args ...core.Value) (core.Value, error)

LOG10 returns the decimal logarithm of a given value. @param {Int | Float} number - Input number. @return {Float} - The decimal logarithm of a given value.

func Log2

func Log2(_ context.Context, args ...core.Value) (core.Value, error)

LOG2 returns the binary logarithm of a given value. @param {Int | Float} number - Input number. @return {Float} - The binary logarithm of a given value.

func Max

func Max(_ context.Context, args ...core.Value) (core.Value, error)

MAX returns the greatest (arithmetic mean) of the values in array. @param {Int[] | Float[]} array - Array of numbers. @return {Float} - The greatest of the values in array.

func Median

func Median(_ context.Context, args ...core.Value) (core.Value, error)

MEDIAN returns the median of the values in array. @param {Int[] | Float[]} array - Array of numbers. @return {Float} - The median of the values in array.

func Min

func Min(_ context.Context, args ...core.Value) (core.Value, error)

MIN returns the smallest (arithmetic mean) of the values in array. @param {Int[] | Float[]} array - Array of numbers. @return {Float} - The smallest of the values in array.

func Percentile

func Percentile(_ context.Context, args ...core.Value) (core.Value, error)

PERCENTILE returns the nth percentile of the values in a given array. @param {Int[] | Float[]} array - Array of numbers. @param {Int} number - A number which must be between 0 (excluded) and 100 (included). @param {String} [method="rank"] - "rank" or "interpolation". @return {Float} - The nth percentile, or null if the array is empty or only null values are contained in it or the percentile cannot be calculated.

func Pi

func Pi(_ context.Context, args ...core.Value) (core.Value, error)

PI returns Pi value. @return {Float} - Pi value.

func PopulationVariance

func PopulationVariance(_ context.Context, args ...core.Value) (core.Value, error)

VARIANCE_POPULATION returns the population variance of the values in a given array. @param {Int[] | Float[]} numbers - Array of numbers. @return {Float} - The population variance.

func Pow

func Pow(_ context.Context, args ...core.Value) (core.Value, error)

POW returns the base to the exponent value. @param {Int | Float} base - The base value. @param {Int | Float} exp - The exponent value. @return {Float} - The exponentiated value.

func Radians

func Radians(_ context.Context, args ...core.Value) (core.Value, error)

RADIANS returns the angle converted from degrees to radians. @param {Int | Float} number - The input number. @return {Float} - The angle in radians.

func Rand

func Rand(_ context.Context, args ...core.Value) (core.Value, error)

RAND return a pseudo-random number between 0 and 1. @param {Int | Float} [max] - Upper limit. @param {Int | Float} [min] - Lower limit. @return {Float} - A number greater than 0 and less than 1.

func Range

func Range(_ context.Context, args ...core.Value) (core.Value, error)

RANGE returns an array of numbers in the specified range, optionally with increments other than 1. @param {Int | Float} start - The value to start the range at (inclusive). @param {Int | Float} end - The value to end the range with (inclusive). @param {Int | Float} [step=1.0] - How much to increment in every step. @return {Int[] | Float[]} - Array of numbers in the specified range, optionally with increments other than 1.

func RegisterLib

func RegisterLib(ns core.Namespace) error

func Round

func Round(_ context.Context, args ...core.Value) (core.Value, error)

ROUND returns the nearest integer, rounding half away from zero. @param {Int | Float} number - Input number. @return {Int} - The nearest integer, rounding half away from zero.

func SampleVariance

func SampleVariance(_ context.Context, args ...core.Value) (core.Value, error)

VARIANCE_SAMPLE returns the sample variance of the values in a given array. @param {Int[] | Float[]} numbers - Array of numbers. @return {Float} - The sample variance.

func Sin

func Sin(_ context.Context, args ...core.Value) (core.Value, error)

SIN returns the sine of the radian argument. @param {Int | Float} number - Input number. @return {Float} - The sin, in radians, of a given number.

func Sqrt

func Sqrt(_ context.Context, args ...core.Value) (core.Value, error)

SQRT returns the square root of a given number. @param {Int | Float} value - A number. @return {Float} - The square root.

func StandardDeviationPopulation

func StandardDeviationPopulation(_ context.Context, args ...core.Value) (core.Value, error)

STDDEV_POPULATION returns the population standard deviation of the values in a given array. @param {Int[] | Float[]} numbers - Array of numbers. @return {Float} - The population standard deviation.

func StandardDeviationSample

func StandardDeviationSample(_ context.Context, args ...core.Value) (core.Value, error)

STDDEV_SAMPLE returns the sample standard deviation of the values in a given array. @param {Int[] | Float[]} numbers - Array of numbers. @return {Float} - The sample standard deviation.

func Sum

func Sum(_ context.Context, args ...core.Value) (core.Value, error)

SUM returns the sum of the values in a given array. @param {Int[] | Float[]} numbers - Array of numbers. @return {Float} - The sum of the values.

func Tan

func Tan(_ context.Context, args ...core.Value) (core.Value, error)

TAN returns the tangent of a given number. @param {Int | Float} number - A number. @return {Float} - The tangent.