NumericFunction uses FunctionCallTrait
AQL offers functions for numeric calculations.
Tags
Table of Contents
Constants
- ABS : string = 'ABS'
- Return the absolute part of value.
- ACOS : string = 'ACOS'
- Return the arccosine of value.
- APPROX_NEAR_COSINE : string = 'APPROX_NEAR_COSINE'
- Return the approximate cosine similarity between two vectors, accelerated by a vector index (cosine metric).
- APPROX_NEAR_L2 : string = 'APPROX_NEAR_L2'
- Return the approximate L2 (Euclidean) distance between two vectors, accelerated by a vector index (l2 metric).
- ASIN : string = 'ASIN'
- Return the arcsine of value.
- ATAN : string = 'ATAN'
- Return the arc tangent of value.
- ATAN2 : string = 'ATAN2'
- Return the arc tangent of the quotient of y and x.
- AVERAGE : string = 'AVERAGE'
- Return the average (arithmetic mean) of the values in array.
- CEIL : string = 'CEIL'
- Return the integer closest but not less than value.
- COS : string = 'COS'
- Return the cosine of value.
- COSINE_SIMILARITY : string = 'COSINE_SIMILARITY'
- Return the cosine similarity between x and y.
- DECAY_EXP : string = 'DECAY_EXP'
- Calculate the score for one or multiple values with an exponential function that decays depending on the distance of a numeric value from a user-given origin.
- DECAY_GAUSS : string = 'DECAY_GAUSS'
- Calculate the score for one or multiple values with a Gaussian function that decays depending on the distance of a numeric value from a user-given origin.
- DECAY_LINEAR : string = 'DECAY_LINEAR'
- Calculate the score for one or multiple values with a linear function that decays depending on the distance of a numeric value from a user-given origin.
- DEGREES : string = 'DEGREES'
- Return the angle converted from radians to degrees.
- EXP : string = 'EXP'
- Return Euler’s constant (2.71828…) raised to the power of value.
- EXP2 : string = 'EXP2'
- Return 2 raised to the power of value.
- FLOOR : string = 'FLOOR'
- Return the integer closest but not greater than value.
- L1_DISTANCE : string = 'L1_DISTANCE'
- Return the Manhattan distance between x and y.
- L2_DISTANCE : string = 'L2_DISTANCE'
- Return the Euclidean distance between x and y.
- LOG : string = 'LOG'
- Return the natural logarithm of value. The base is Euler’s constant (2.71828…).
- LOG10 : string = 'LOG10'
- Return the base 10 logarithm of value.
- LOG2 : string = 'LOG2'
- Return the base 2 logarithm of value.
- MAX : string = 'MAX'
- Return the greatest element of anyArray. The array is not limited to numbers.
- MEDIAN : string = 'MEDIAN'
- Return the median value of the values in array.
- MIN : string = 'MIN'
- Return the smallest element of anyArray.
- PERCENTILE : string = 'PERCENTILE'
- Return the nth percentile of the values in numArray.
- PI : string = 'PI'
- Return pi.
- POW : string = 'POW'
- Return the base to the exponent exp.
- PRODUCT : string = 'PRODUCT'
- Return the product of the values in array.
- RADIANS : string = 'RADIANS'
- Return the angle converted from degrees to radians.
- RAND : string = 'RAND'
- Return a pseudo-random number between 0 and 1.
- RANGE : string = 'RANGE'
- Return an array of numbers in the specified range, optionally with increments other than 1.
- ROUND : string = 'ROUND'
- Return the integer closest to value.
- SIN : string = 'SIN'
- Return the sine of value.
- SQRT : string = 'SQRT'
- Return the square root of value.
- STDDEV_POPULATION : string = 'STDDEV_POPULATION'
- Return the population standard deviation of the values in array.
- STDDEV_SAMPLE : string = 'STDDEV_SAMPLE'
- Return the sample standard deviation of the values in array.
- SUM : string = 'SUM'
- Return the sum of the values in array.
- TAN : string = 'TAN'
- Return the tangent of value.
- VARIANCE_POPULATION : string = 'VARIANCE_POPULATION'
- Return the population variance of the values in array.
- VARIANCE_SAMPLE : string = 'VARIANCE_SAMPLE'
- Return the sample variance of the values in array.
Constants
ABS
Return the absolute part of value.
public
string
ABS
= 'ABS'
ACOS
Return the arccosine of value.
public
string
ACOS
= 'ACOS'
APPROX_NEAR_COSINE
Return the approximate cosine similarity between two vectors, accelerated by a vector index (cosine metric).
public
string
APPROX_NEAR_COSINE
= 'APPROX_NEAR_COSINE'
APPROX_NEAR_L2
Return the approximate L2 (Euclidean) distance between two vectors, accelerated by a vector index (l2 metric).
public
string
APPROX_NEAR_L2
= 'APPROX_NEAR_L2'
ASIN
Return the arcsine of value.
public
string
ASIN
= 'ASIN'
ATAN
Return the arc tangent of value.
public
string
ATAN
= 'ATAN'
ATAN2
Return the arc tangent of the quotient of y and x.
public
string
ATAN2
= 'ATAN2'
AVERAGE
Return the average (arithmetic mean) of the values in array.
public
string
AVERAGE
= 'AVERAGE'
CEIL
Return the integer closest but not less than value.
public
string
CEIL
= 'CEIL'
COS
Return the cosine of value.
public
string
COS
= 'COS'
COSINE_SIMILARITY
Return the cosine similarity between x and y.
public
string
COSINE_SIMILARITY
= 'COSINE_SIMILARITY'
DECAY_EXP
Calculate the score for one or multiple values with an exponential function that decays depending on the distance of a numeric value from a user-given origin.
public
string
DECAY_EXP
= 'DECAY_EXP'
DECAY_GAUSS
Calculate the score for one or multiple values with a Gaussian function that decays depending on the distance of a numeric value from a user-given origin.
public
string
DECAY_GAUSS
= 'DECAY_GAUSS'
DECAY_LINEAR
Calculate the score for one or multiple values with a linear function that decays depending on the distance of a numeric value from a user-given origin.
public
string
DECAY_LINEAR
= 'DECAY_LINEAR'
DEGREES
Return the angle converted from radians to degrees.
public
string
DEGREES
= 'DEGREES'
EXP
Return Euler’s constant (2.71828…) raised to the power of value.
public
string
EXP
= 'EXP'
EXP2
Return 2 raised to the power of value.
public
string
EXP2
= 'EXP2'
FLOOR
Return the integer closest but not greater than value.
public
string
FLOOR
= 'FLOOR'
L1_DISTANCE
Return the Manhattan distance between x and y.
public
string
L1_DISTANCE
= 'L1_DISTANCE'
L2_DISTANCE
Return the Euclidean distance between x and y.
public
string
L2_DISTANCE
= 'L2_DISTANCE'
LOG
Return the natural logarithm of value. The base is Euler’s constant (2.71828…).
public
string
LOG
= 'LOG'
LOG10
Return the base 10 logarithm of value.
public
string
LOG10
= 'LOG10'
LOG2
Return the base 2 logarithm of value.
public
string
LOG2
= 'LOG2'
MAX
Return the greatest element of anyArray. The array is not limited to numbers.
public
string
MAX
= 'MAX'
MEDIAN
Return the median value of the values in array.
public
string
MEDIAN
= 'MEDIAN'
MIN
Return the smallest element of anyArray.
public
string
MIN
= 'MIN'
PERCENTILE
Return the nth percentile of the values in numArray.
public
string
PERCENTILE
= 'PERCENTILE'
PI
Return pi.
public
string
PI
= 'PI'
POW
Return the base to the exponent exp.
public
string
POW
= 'POW'
PRODUCT
Return the product of the values in array.
public
string
PRODUCT
= 'PRODUCT'
RADIANS
Return the angle converted from degrees to radians.
public
string
RADIANS
= 'RADIANS'
RAND
Return a pseudo-random number between 0 and 1.
public
string
RAND
= 'RAND'
RANGE
Return an array of numbers in the specified range, optionally with increments other than 1.
public
string
RANGE
= 'RANGE'
The start and stop arguments are truncated to integers unless a step argument is provided.
ROUND
Return the integer closest to value.
public
string
ROUND
= 'ROUND'
SIN
Return the sine of value.
public
string
SIN
= 'SIN'
SQRT
Return the square root of value.
public
string
SQRT
= 'SQRT'
STDDEV_POPULATION
Return the population standard deviation of the values in array.
public
string
STDDEV_POPULATION
= 'STDDEV_POPULATION'
STDDEV_SAMPLE
Return the sample standard deviation of the values in array.
public
string
STDDEV_SAMPLE
= 'STDDEV_SAMPLE'
SUM
Return the sum of the values in array.
public
string
SUM
= 'SUM'
TAN
Return the tangent of value.
public
string
TAN
= 'TAN'
VARIANCE_POPULATION
Return the population variance of the values in array.
public
string
VARIANCE_POPULATION
= 'VARIANCE_POPULATION'
VARIANCE_SAMPLE
Return the sample variance of the values in array.
public
string
VARIANCE_SAMPLE
= 'VARIANCE_SAMPLE'