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 NewLib() map[string]core.Function
• 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 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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number1 (Int|Float) - Input number. @param number2 (Int|Float) - Input number. @returns (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 array (Array) - Array of numbers. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Float|Int) - The input number. @returns (Float) - The angle in degrees.l

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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 number (Int|Float) - Input number. @returns (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 array (Array) - Array of numbers. @returns (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 array (Array) - Array of numbers. @returns (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 array (Array) - Array of numbers. @returns (Float) - The smallest of the values in array.

func NewLib

func NewLib() map[string]core.Function

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 array (Array) - Array of numbers. @param numb (Int) - A number which must be between 0 (excluded) and 100 (included). @param method (String, optional) - "rank" (default) or "interpolation". @returns (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. @returns (Float) - Pi value.

func PopulationVariance

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

PopulationVariance returns the population variance of the values in a given array. @params (Array) - Array of numbers. @returns (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 base (Int|Float) - The base value. @param exp (Int|Float) - The exponent value. @returns (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 number (Float|Int) - The input number. @returns (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. @returns (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 start (Int|Float) - The value to start the range at (inclusive). @param end (Int|Float) - The value to end the range with (inclusive). @param step (Int|Float, optional) - How much to increment in every step, the default is 1.0.

func Round

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

Round returns the nearest integer, rounding half away from zero. @param number (Int|Float) - Input number. @returns (Int) - The nearest integer, rounding half away from zero.

func SampleVariance

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

SampleVariance returns the sample variance of the values in a given array. @params (Array) - Array of numbers. @returns (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 number (Int|Float) - Input number. @returns (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 value (Int|Float) - A number. @returns (Float) - The square root.

func StandardDeviationPopulation

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

StandardDeviationPopulation returns the population standard deviation of the values in a given array. @params (Array) - Array of numbers. @returns (Float) - The population standard deviation.

func StandardDeviationSample

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

StandardDeviationSample returns the sample standard deviation of the values in a given array. @params (Array) - Array of numbers. @returns (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 array (Array) - Array of numbers. @returns (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 value (Int|Float) - A number. @returns (Float) - The tangent.