Documentation Index
Fetch the complete documentation index at: https://private-7c7dfe99-test-mutation-observers.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
acos
Introduced in: v1.1.0 Returns the arc cosine of the argument. SyntaxFloat*
Examples
Usage example
Query
Response
acosh
Introduced in: v20.12.0 Returns the inverse hyperbolic cosine. Syntax0 ≤ acosh(x) < +∞. Float64
Examples
Usage example
Query
Response
asin
Introduced in: v1.1.0 Calculates the arcsine of the provided argument. For arguments in the range[-1, 1] it returns the value in the range of [-pi() / 2, pi() / 2].
Syntax
x Float64
Examples
inverse
Query
Response
Query
Response
Query
Response
asinh
Introduced in: v20.12.0 Returns the inverse hyperbolic sine. Syntax-∞ < asinh(x) < +∞. Float64
Examples
Basic usage
Query
Response
atan
Introduced in: v1.1.0 Returns the arc tangent of the argument. Syntaxx. Float*
Examples
Usage example
Query
Response
atan2
Introduced in: v20.12.0 Returns the atan2 as the angle in the Euclidean plane, given in radians, between the positive x axis and the ray to the point(x, y) ≠ (0, 0).
Syntax
y— y-coordinate of the point through which the ray passes.(U)Int*orFloat*orDecimal*x— x-coordinate of the point through which the ray passes.(U)Int*orFloat*orDecimal*
θ such that -π < θ ≤ π, in radians Float64
Examples
Usage example
Query
Response
atanh
Introduced in: v20.12.0 Returns the inverse hyperbolic tangent. Syntaxx— Hyperbolic tangent of angle. Values from the interval: -1 < x < 1.(U)Int*,Float*orDecimal*.(U)Int*orFloat*orDecimal*
Float64
Examples
Usage example
Query
Response
cbrt
Introduced in: v1.1.0 Returns the cubic root of the argument. Syntaxx. Float*
Examples
Usage example
Query
Response
cos
Introduced in: v1.1.0 Returns the cosine of the argument. Syntaxx. Float*
Examples
Usage example
Query
Response
cosh
Introduced in: v20.12.0 Returns the hyperbolic cosine of the argument. Syntax1 ≤ cosh(x) < +∞ Float64
Examples
Basic usage
Query
Response
degrees
Introduced in: v22.2.0 Converts radians to degrees. Syntaxx in degrees. Float64
Examples
Basic usage
Query
Response
e
Introduced in: v1.1.0 Returns Euler’s constant (e). Syntax- None.
Float64
Examples
Usage example
Query
Response
erf
Introduced in: v1.1.0 Ifx is non-negative, then erf(x/(σ√2)) is the probability that a random variable having a normal distribution with standard deviation σ takes the value that is separated from the expected value by more than x.
Syntax
Float*
Examples
Three sigma rule
Query
Response
erfc
Introduced in: v1.1.0 Returns a number close to1-erf(x) without loss of precision for large x values.
Syntax
Float*
Examples
Usage example
Query
Response
exp
Introduced in: v1.1.0 Returns e raised to the power ofx, where x is the given argument to the function.
Syntax
e^x Float*
Examples
Basic usage
Query
Response
exp10
Introduced in: v1.1.0 Returns 10 to the power of the given argument. SyntaxFloat*
Examples
Usage example
Query
Response
exp2
Introduced in: v1.1.0 Returns 2 to the power of the given argument. SyntaxFloat*
Examples
Usage example
Query
Response
factorial
Introduced in: v22.11.0 Computes the factorial of an integer value. The factorial of 0 is 1. Likewise, thefactorial() function returns 1 for any negative value.
The maximum positive value for the input argument is 20, a value of 21 or greater will cause an exception.
Syntax
n— Integer value for which to calculate the factorial. Maximum value is 20.(U)Int8/16/32/64
UInt64
Examples
Usage example
Query
Response
hypot
Introduced in: v20.12.0 Returns the length of the hypotenuse of a right-angle triangle. Hypot avoids problems that occur when squaring very large or very small numbers. Syntaxx— The first cathetus of a right-angle triangle.(U)Int*orFloat*orDecimal*y— The second cathetus of a right-angle triangle.(U)Int*orFloat*orDecimal*
Float64
Examples
Basic usage
Query
Response
intExp10
Introduced in: v1.1.0 Like exp10 but returns aUInt64 number.
Syntax
UInt64
Examples
Usage example
Query
Response
intExp2
Introduced in: v1.1.0 Like exp2 but returns aUInt64 number.
Syntax
UInt64
Examples
Usage example
Query
Response
isPrime
Introduced in: v26.5.0 Returns1 if the argument is a prime number, otherwise 0.
Uses an exact lookup bitmap for small values and a deterministic Miller-Rabin test
for larger values. The result is exact for every supported input type.
For wider unsigned integer types (UInt128, UInt256), use isProbablePrime instead.
Syntax
1 if n is prime, 0 otherwise. UInt8
Examples
Prime number
Query
Response
Query
Response
UInt64 prime
Query
Response
UInt64 value
Query
Response
isProbablePrime
Introduced in: v26.5.0 Returns1 if the argument is probably prime, 0 if it is definitely composite.
For UInt8, UInt16, UInt32, and UInt64, the result is exact and matches
isPrime. The rounds argument is ignored.
For UInt128 and UInt256, a return value of 1 is probabilistic. The optional rounds argument controls
how many Miller-Rabin rounds are used:
more rounds reduce the chance of a false positive and increase the running time. With uniformly random
witnesses, the false-positive rate for a fixed composite is bounded by 4^(-rounds); the default of 25
makes this bound smaller than 10^-15. Values above 256 are rejected as BAD_ARGUMENTS, since they
offer no meaningful improvement and only waste time.
The function is deterministic: witnesses are derived from a fixed seed computed from n, so the same
(n, rounds) pair always produces the same result. As a consequence, a composite that happens to pass
this particular witness sequence will reproducibly return 1, rather than failing the test independently
on each call. The 4^(-rounds) bound should therefore be read as a guide to typical accuracy across
inputs, not as a per-call probability for a fixed input.
Syntax
n— Unsigned integer to test for primality.UInt8orUInt16orUInt32orUInt64orUInt128orUInt256rounds— Optional positive integer constant in[1, 256]. Number of Miller-Rabin rounds forUInt128/UInt256(ignored for narrower types). Default25.UInt8orUInt16orUInt32orUInt64
1 if n is probably prime, 0 if it is definitely composite. UInt8
Examples
Small prime
Query
Response
Query
Response
UInt64 prime (exact result)
Query
Response
M_127 (UInt128)
Query
Response
2^255 - 19 (UInt256)
Query
Response
Query
Response
lgamma
Introduced in: v1.1.0 Returns the logarithm of the gamma function. Syntaxx— The number for which to compute the logarithm of the gamma function.(U)Int*orFloat*orDecimal*
x. Float*
Examples
Usage example
Query
Response
log
Introduced in: v1.1.0 Returns the natural logarithm of the argument. Syntaxln
Arguments
Returned value
Returns the natural logarithm of x. Float*
Examples
Usage example
Query
Response
log10
Introduced in: v1.1.0 Returns the decimal logarithm of the argument. Syntaxx. Float*
Examples
Usage example
Query
Response
log1p
Introduced in: v20.12.0 Calculates log(1+x). The calculation log1p(x) is more accurate than log(1+x) for small values ofx.
Syntax
Float64
Examples
Usage example
Query
Response
log2
Introduced in: v1.1.0 Returns the binary logarithm of the argument. Syntaxx. Float*
Examples
Usage example
Query
Response
pi
Introduced in: v1.1.0 Returns pi (π). Syntax- None.
Float64
Examples
Usage example
Query
Response
pow
Introduced in: v1.1.0 Returns x raised to the power of y. Syntaxpower
Arguments
x— The base.(U)Int8/16/32/64orFloat*orDecimal*y— The exponent.(U)Int8/16/32/64orFloat*orDecimal*
Float64
Examples
Usage example
Query
Response
proportionsZTest
Introduced in: v22.3.0 Returns test statistics for the two proportion Z-test - a statistical test for comparing the proportions from two populations x and y. The function supports both pooled and unpooled estimation methods for the standard error. In the pooled version, the two proportions are averaged and only one proportion is used to estimate the standard error. In the unpooled version, the two proportions are used separately. Syntaxsuccesses_x— Number of successes in population x.UInt64successes_y— Number of successes in population y.UInt64trials_x— Number of trials in population x.UInt64trials_y— Number of trials in population y.UInt64conf_level— Confidence level for the test.Float64pool_type— Selection of pooling method for standard error estimation. Can be either ‘unpooled’ or ‘pooled’.String
z_stat (Z statistic), p_val (P value), ci_low (lower confidence interval), ci_high (upper confidence interval). Tuple(Float64, Float64, Float64, Float64)
Examples
Usage example
Query
Response
radians
Introduced in: v22.2.0 Converts degrees to radians. SyntaxFloat64
Examples
Usage example
Query
Response
sigmoid
Introduced in: v20.1.0 Calculates the sigmoid function:1 / (1 + exp(-x)). The sigmoid function maps any real number to the range (0, 1) and is commonly used in machine learning.
Syntax
Float64
Examples
Basic usage
Query
Response
sign
Introduced in: v21.2.0 Returns the sign of a real number. Syntax-1 for x < 0, 0 for x = 0, 1 for x > 0. Int8
Examples
Sign for zero
Query
Response
Query
Response
Query
Response
sin
Introduced in: v1.1.0 Returns the sine of the argument. SyntaxQuery
Response
sinh
Introduced in: v20.12.0 Returns the hyperbolic sine. SyntaxFloat64
Examples
Usage example
Query
Response
sqrt
Introduced in: v1.1.0 Returns the square root of the argument. SyntaxFloat*
Examples
Usage example
Query
Response
tan
Introduced in: v1.1.0 Returns the tangent of the argument. Syntaxx. Float*
Examples
Usage example
Query
Response
tanh
Introduced in: v20.1.0 Returns the hyperbolic tangent. SyntaxFloat*
Examples
Usage example
Query
Response
tgamma
Introduced in: v1.1.0 Returns the gamma function. SyntaxFloat*
Examples
Usage example
Query
Response
widthBucket
Introduced in: v23.3.0 Returns the number of the bucket in which parameteroperand falls in a histogram having count equal-width buckets spanning the range low to high. Returns 0 if operand is less than low, and returns count+1 if operand is greater than or equal to high.
There is also a case insensitive alias called WIDTH_BUCKET to provide compatibility with other databases.
Syntax
width_bucket
Arguments
operand— The value for which to determine the bucket.(U)Int8/16/32/64low— The lower bound of the histogram range.(U)Int8/16/32/64high— The upper bound of the histogram range.(U)Int8/16/32/64count— The number of equal-width buckets. Cannot be zero.UInt8/16/32/64
UInt8/16/32/64
Examples
Usage example
Query
Response