{"route":"/en-US-v0.14.1/reference/foundations/calc/","title":"Calculation","description":"Documentation for the calc functions.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"functions","name":"Functions","children":[{"id":"functions-abs","name":"Absolute","children":[{"id":"functions-abs-value","name":"value","children":[]}]},{"id":"functions-pow","name":"Power","children":[{"id":"functions-pow-base","name":"base","children":[]},{"id":"functions-pow-exponent","name":"exponent","children":[]}]},{"id":"functions-exp","name":"Exponential","children":[{"id":"functions-exp-exponent","name":"exponent","children":[]}]},{"id":"functions-sqrt","name":"Square Root","children":[{"id":"functions-sqrt-value","name":"value","children":[]}]},{"id":"functions-root","name":"Root","children":[{"id":"functions-root-radicand","name":"radicand","children":[]},{"id":"functions-root-index","name":"index","children":[]}]},{"id":"functions-sin","name":"Sine","children":[{"id":"functions-sin-angle","name":"angle","children":[]}]},{"id":"functions-cos","name":"Cosine","children":[{"id":"functions-cos-angle","name":"angle","children":[]}]},{"id":"functions-tan","name":"Tangent","children":[{"id":"functions-tan-angle","name":"angle","children":[]}]},{"id":"functions-asin","name":"Arcsine","children":[{"id":"functions-asin-value","name":"value","children":[]}]},{"id":"functions-acos","name":"Arccosine","children":[{"id":"functions-acos-value","name":"value","children":[]}]},{"id":"functions-atan","name":"Arctangent","children":[{"id":"functions-atan-value","name":"value","children":[]}]},{"id":"functions-atan2","name":"Four-quadrant Arctangent","children":[{"id":"functions-atan2-x","name":"x","children":[]},{"id":"functions-atan2-y","name":"y","children":[]}]},{"id":"functions-sinh","name":"Hyperbolic Sine","children":[{"id":"functions-sinh-value","name":"value","children":[]}]},{"id":"functions-cosh","name":"Hyperbolic Cosine","children":[{"id":"functions-cosh-value","name":"value","children":[]}]},{"id":"functions-tanh","name":"Hyperbolic Tangent","children":[{"id":"functions-tanh-value","name":"value","children":[]}]},{"id":"functions-log","name":"Logarithm","children":[{"id":"functions-log-value","name":"value","children":[]},{"id":"functions-log-base","name":"base","children":[]}]},{"id":"functions-ln","name":"Natural Logarithm","children":[{"id":"functions-ln-value","name":"value","children":[]}]},{"id":"functions-fact","name":"Factorial","children":[{"id":"functions-fact-number","name":"number","children":[]}]},{"id":"functions-perm","name":"Permutation","children":[{"id":"functions-perm-base","name":"base","children":[]},{"id":"functions-perm-numbers","name":"numbers","children":[]}]},{"id":"functions-binom","name":"Binomial","children":[{"id":"functions-binom-n","name":"n","children":[]},{"id":"functions-binom-k","name":"k","children":[]}]},{"id":"functions-gcd","name":"Greatest Common Divisor","children":[{"id":"functions-gcd-a","name":"a","children":[]},{"id":"functions-gcd-b","name":"b","children":[]}]},{"id":"functions-lcm","name":"Least Common Multiple","children":[{"id":"functions-lcm-a","name":"a","children":[]},{"id":"functions-lcm-b","name":"b","children":[]}]},{"id":"functions-floor","name":"Floor","children":[{"id":"functions-floor-value","name":"value","children":[]}]},{"id":"functions-ceil","name":"Ceil","children":[{"id":"functions-ceil-value","name":"value","children":[]}]},{"id":"functions-trunc","name":"Truncate","children":[{"id":"functions-trunc-value","name":"value","children":[]}]},{"id":"functions-fract","name":"Fractional","children":[{"id":"functions-fract-value","name":"value","children":[]}]},{"id":"functions-round","name":"Round","children":[{"id":"functions-round-value","name":"value","children":[]},{"id":"functions-round-digits","name":"digits","children":[]}]},{"id":"functions-clamp","name":"Clamp","children":[{"id":"functions-clamp-value","name":"value","children":[]},{"id":"functions-clamp-min","name":"min","children":[]},{"id":"functions-clamp-max","name":"max","children":[]}]},{"id":"functions-min","name":"Minimum","children":[{"id":"functions-min-values","name":"values","children":[]}]},{"id":"functions-max","name":"Maximum","children":[{"id":"functions-max-values","name":"values","children":[]}]},{"id":"functions-even","name":"Even","children":[{"id":"functions-even-value","name":"value","children":[]}]},{"id":"functions-odd","name":"Odd","children":[{"id":"functions-odd-value","name":"value","children":[]}]},{"id":"functions-rem","name":"Remainder","children":[{"id":"functions-rem-dividend","name":"dividend","children":[]},{"id":"functions-rem-divisor","name":"divisor","children":[]}]},{"id":"functions-div-euclid","name":"Euclidean Division","children":[{"id":"functions-div-euclid-dividend","name":"dividend","children":[]},{"id":"functions-div-euclid-divisor","name":"divisor","children":[]}]},{"id":"functions-rem-euclid","name":"Euclidean Remainder","children":[{"id":"functions-rem-euclid-dividend","name":"dividend","children":[]},{"id":"functions-rem-euclid-divisor","name":"divisor","children":[]}]},{"id":"functions-quo","name":"Quotient","children":[{"id":"functions-quo-dividend","name":"dividend","children":[]},{"id":"functions-quo-divisor","name":"divisor","children":[]}]},{"id":"functions-norm","name":"𝑝-Norm","children":[{"id":"functions-norm-p","name":"p","children":[]},{"id":"functions-norm-values","name":"values","children":[]}]}]}],"body":{"kind":"group","content":{"name":"calc","title":"Calculation","details":"

Module for calculations and processing of numeric values.

\n

These definitions are part of the calc module and not imported by default.\nIn addition to the functions listed below, the calc module also defines\nthe constants pi, tau, e, and inf.

","functions":[{"path":["calc"],"name":"abs","title":"Absolute","keywords":[],"oneliner":"Calculates the absolute value of a numeric value.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the absolute value of a numeric value.

"},{"kind":"example","content":{"body":"
#calc.abs(-5) \\\n#calc.abs(5pt - 2cm) \\\n#calc.abs(2fr) \\\n#calc.abs(decimal("-342.440"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The value whose absolute value to calculate.

"}],"types":["int","float","length","angle","ratio","fraction","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["calc"],"name":"pow","title":"Power","keywords":[],"oneliner":"Raises a value to some exponent.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Raises a value to some exponent.

"},{"kind":"example","content":{"body":"
#calc.pow(2, 3) \\\n#calc.pow(decimal("2.5"), 2)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"base","details":[{"kind":"html","content":"

The base of the power.

\n

If this is a decimal, the exponent can only be an integer.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"exponent","details":[{"kind":"html","content":"

The exponent of the power.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"exp","title":"Exponential","keywords":[],"oneliner":"Raises a value to some exponent of e.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Raises a value to some exponent of e.

"},{"kind":"example","content":{"body":"
#calc.exp(1)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"exponent","details":[{"kind":"html","content":"

The exponent of the power.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"sqrt","title":"Square Root","keywords":[],"oneliner":"Calculates the square root of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the square root of a number.

"},{"kind":"example","content":{"body":"
#calc.sqrt(16) \\\n#calc.sqrt(2.5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number whose square root to calculate. Must be non-negative.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"root","title":"Root","keywords":[],"oneliner":"Calculates the real nth root of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the real nth root of a number.

\n

If the number is negative, then n must be odd.

"},{"kind":"example","content":{"body":"
#calc.root(16.0, 4) \\\n#calc.root(27.0, 3)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"radicand","details":[{"kind":"html","content":"

The expression to take the root of.

"}],"types":["float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"index","details":[{"kind":"html","content":"

Which root of the radicand to take.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"sin","title":"Sine","keywords":[],"oneliner":"Calculates the sine of an angle.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the sine of an angle.

\n

When called with an integer or a float, they will be interpreted as\nradians.

"},{"kind":"example","content":{"body":"
#calc.sin(1.5) \\\n#calc.sin(90deg)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"angle","details":[{"kind":"html","content":"

The angle whose sine to calculate.

"}],"types":["int","float","angle"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"cos","title":"Cosine","keywords":[],"oneliner":"Calculates the cosine of an angle.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the cosine of an angle.

\n

When called with an integer or a float, they will be interpreted as\nradians.

"},{"kind":"example","content":{"body":"
#calc.cos(1.5) \\\n#calc.cos(90deg)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"angle","details":[{"kind":"html","content":"

The angle whose cosine to calculate.

"}],"types":["int","float","angle"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"tan","title":"Tangent","keywords":[],"oneliner":"Calculates the tangent of an angle.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the tangent of an angle.

\n

When called with an integer or a float, they will be interpreted as\nradians.

"},{"kind":"example","content":{"body":"
#calc.tan(1.5) \\\n#calc.tan(90deg)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"angle","details":[{"kind":"html","content":"

The angle whose tangent to calculate.

"}],"types":["int","float","angle"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"asin","title":"Arcsine","keywords":[],"oneliner":"Calculates the arcsine of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the arcsine of a number.

"},{"kind":"example","content":{"body":"
#calc.asin(0) \\\n#calc.asin(1)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number whose arcsine to calculate. Must be between -1 and 1.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["angle"],"scope":[]},{"path":["calc"],"name":"acos","title":"Arccosine","keywords":[],"oneliner":"Calculates the arccosine of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the arccosine of a number.

"},{"kind":"example","content":{"body":"
#calc.acos(0) \\\n#calc.acos(1)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number whose arccosine to calculate. Must be between -1 and 1.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["angle"],"scope":[]},{"path":["calc"],"name":"atan","title":"Arctangent","keywords":[],"oneliner":"Calculates the arctangent of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the arctangent of a number.

"},{"kind":"example","content":{"body":"
#calc.atan(0) \\\n#calc.atan(1)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number whose arctangent to calculate.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["angle"],"scope":[]},{"path":["calc"],"name":"atan2","title":"Four-quadrant Arctangent","keywords":[],"oneliner":"Calculates the four-quadrant arctangent of a coordinate.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the four-quadrant arctangent of a coordinate.

\n

The arguments are (x, y), not (y, x).

"},{"kind":"example","content":{"body":"
#calc.atan2(1, 1) \\\n#calc.atan2(-2, -3)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"x","details":[{"kind":"html","content":"

The X coordinate.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"y","details":[{"kind":"html","content":"

The Y coordinate.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["angle"],"scope":[]},{"path":["calc"],"name":"sinh","title":"Hyperbolic Sine","keywords":[],"oneliner":"Calculates the hyperbolic sine of a hyperbolic angle.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the hyperbolic sine of a hyperbolic angle.

"},{"kind":"example","content":{"body":"
#calc.sinh(0) \\\n#calc.sinh(1.5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The hyperbolic angle whose hyperbolic sine to calculate.

"}],"types":["float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"cosh","title":"Hyperbolic Cosine","keywords":[],"oneliner":"Calculates the hyperbolic cosine of a hyperbolic angle.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the hyperbolic cosine of a hyperbolic angle.

"},{"kind":"example","content":{"body":"
#calc.cosh(0) \\\n#calc.cosh(1.5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The hyperbolic angle whose hyperbolic cosine to calculate.

"}],"types":["float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"tanh","title":"Hyperbolic Tangent","keywords":[],"oneliner":"Calculates the hyperbolic tangent of a hyperbolic angle.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the hyperbolic tangent of a hyperbolic angle.

"},{"kind":"example","content":{"body":"
#calc.tanh(0) \\\n#calc.tanh(1.5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The hyperbolic angle whose hyperbolic tangent to calculate.

"}],"types":["float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"log","title":"Logarithm","keywords":[],"oneliner":"Calculates the logarithm of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the logarithm of a number.

\n

If the base is not specified, the logarithm is calculated in base 10.

"},{"kind":"example","content":{"body":"
#calc.log(100)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number whose logarithm to calculate. Must be strictly positive.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"base","details":[{"kind":"html","content":"

The base of the logarithm. May not be zero.

"}],"types":["float"],"strings":[],"default":"10.0","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"ln","title":"Natural Logarithm","keywords":[],"oneliner":"Calculates the natural logarithm of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the natural logarithm of a number.

"},{"kind":"example","content":{"body":"
#calc.ln(calc.e)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number whose logarithm to calculate. Must be strictly positive.

"}],"types":["int","float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["float"],"scope":[]},{"path":["calc"],"name":"fact","title":"Factorial","keywords":[],"oneliner":"Calculates the factorial of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the factorial of a number.

"},{"kind":"example","content":{"body":"
#calc.fact(5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"number","details":[{"kind":"html","content":"

The number whose factorial to calculate. Must be non-negative.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"perm","title":"Permutation","keywords":[],"oneliner":"Calculates a permutation.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates a permutation.

\n

Returns the k-permutation of n, or the number of ways to choose k\nitems from a set of n with regard to order.

"},{"kind":"example","content":{"body":"
$ "perm"(n, k) &= n!/((n - k)!) \\\n  "perm"(5, 3) &= #calc.perm(5, 3) $\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"base","details":[{"kind":"html","content":"

The base number. Must be non-negative.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"numbers","details":[{"kind":"html","content":"

The number of permutations. Must be non-negative.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"binom","title":"Binomial","keywords":[],"oneliner":"Calculates a binomial coefficient.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates a binomial coefficient.

\n

Returns the k-combination of n, or the number of ways to choose k\nitems from a set of n without regard to order.

"},{"kind":"example","content":{"body":"
#calc.binom(10, 5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"n","details":[{"kind":"html","content":"

The upper coefficient. Must be non-negative.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"k","details":[{"kind":"html","content":"

The lower coefficient. Must be non-negative.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"gcd","title":"Greatest Common Divisor","keywords":[],"oneliner":"Calculates the greatest common divisor of two integers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the greatest common divisor of two integers.

\n

This will error if the result of integer division would be larger than the\nmaximum 64-bit signed integer.

"},{"kind":"example","content":{"body":"
#calc.gcd(7, 42)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"a","details":[{"kind":"html","content":"

The first integer.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"b","details":[{"kind":"html","content":"

The second integer.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"lcm","title":"Least Common Multiple","keywords":[],"oneliner":"Calculates the least common multiple of two integers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the least common multiple of two integers.

"},{"kind":"example","content":{"body":"
#calc.lcm(96, 13)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"a","details":[{"kind":"html","content":"

The first integer.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"b","details":[{"kind":"html","content":"

The second integer.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"floor","title":"Floor","keywords":[],"oneliner":"Rounds a number down to the nearest integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Rounds a number down to the nearest integer.

\n

If the number is already an integer, it is returned unchanged.

\n

Note that this function will always return an integer, and will\nerror if the resulting float or decimal is larger than the maximum\n64-bit signed integer or smaller than the minimum for that type.

"},{"kind":"example","content":{"body":"
#calc.floor(500.1)\n#assert(calc.floor(3) == 3)\n#assert(calc.floor(3.14) == 3)\n#assert(calc.floor(decimal("-3.14")) == -4)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to round down.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"ceil","title":"Ceil","keywords":[],"oneliner":"Rounds a number up to the nearest integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Rounds a number up to the nearest integer.

\n

If the number is already an integer, it is returned unchanged.

\n

Note that this function will always return an integer, and will\nerror if the resulting float or decimal is larger than the maximum\n64-bit signed integer or smaller than the minimum for that type.

"},{"kind":"example","content":{"body":"
#calc.ceil(500.1)\n#assert(calc.ceil(3) == 3)\n#assert(calc.ceil(3.14) == 4)\n#assert(calc.ceil(decimal("-3.14")) == -3)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to round up.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"trunc","title":"Truncate","keywords":[],"oneliner":"Returns the integer part of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the integer part of a number.

\n

If the number is already an integer, it is returned unchanged.

\n

Note that this function will always return an integer, and will\nerror if the resulting float or decimal is larger than the maximum\n64-bit signed integer or smaller than the minimum for that type.

"},{"kind":"example","content":{"body":"
#calc.trunc(15.9)\n#assert(calc.trunc(3) == 3)\n#assert(calc.trunc(-3.7) == -3)\n#assert(calc.trunc(decimal("8493.12949582390")) == 8493)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to truncate.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"fract","title":"Fractional","keywords":[],"oneliner":"Returns the fractional part of a number.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the fractional part of a number.

\n

If the number is an integer, returns 0.

"},{"kind":"example","content":{"body":"
#calc.fract(-3.1)\n#assert(calc.fract(3) == 0)\n#assert(calc.fract(decimal("234.23949211")) == decimal("0.23949211"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to truncate.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"round","title":"Round","keywords":[],"oneliner":"Rounds a number to the nearest integer.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Rounds a number to the nearest integer.

\n

Half-integers are rounded away from zero.

\n

Optionally, a number of decimal places can be specified. If negative, its\nabsolute value will indicate the amount of significant integer digits to\nremove before the decimal point.

\n

Note that this function will return the same type as the operand. That is,\napplying round to a float will return a float, and to a decimal,\nanother decimal. You may explicitly convert the output of this function to\nan integer with int, but note that such a conversion will error if the\nfloat or decimal is larger than the maximum 64-bit signed integer or\nsmaller than the minimum integer.

\n

In addition, this function can error if there is an attempt to round beyond\nthe maximum or minimum integer or decimal. If the number is a float,\nsuch an attempt will cause float.inf or -float.inf to be returned\nfor maximum and minimum respectively.

"},{"kind":"example","content":{"body":"
#calc.round(3.1415, digits: 2)\n#assert(calc.round(3) == 3)\n#assert(calc.round(3.14) == 3)\n#assert(calc.round(3.5) == 4.0)\n#assert(calc.round(3333.45, digits: -2) == 3300.0)\n#assert(calc.round(-48953.45, digits: -3) == -49000.0)\n#assert(calc.round(3333, digits: -2) == 3300)\n#assert(calc.round(-48953, digits: -3) == -49000)\n#assert(calc.round(decimal("-6.5")) == decimal("-7"))\n#assert(calc.round(decimal("7.123456789"), digits: 6) == decimal("7.123457"))\n#assert(calc.round(decimal("3333.45"), digits: -2) == decimal("3300"))\n#assert(calc.round(decimal("-48953.45"), digits: -3) == decimal("-49000"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to round.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"digits","details":[{"kind":"html","content":"

If positive, the number of decimal places.

\n

If negative, the number of significant integer digits that should be\nremoved before the decimal point.

"}],"types":["int"],"strings":[],"default":"0","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"clamp","title":"Clamp","keywords":[],"oneliner":"Clamps a number between a minimum and maximum value.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Clamps a number between a minimum and maximum value.

"},{"kind":"example","content":{"body":"
#calc.clamp(5, 0, 4)\n#assert(calc.clamp(5, 0, 10) == 5)\n#assert(calc.clamp(5, 6, 10) == 6)\n#assert(calc.clamp(decimal("5.45"), 2, decimal("45.9")) == decimal("5.45"))\n#assert(calc.clamp(decimal("5.45"), decimal("6.75"), 12) == decimal("6.75"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to clamp.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"min","details":[{"kind":"html","content":"

The inclusive minimum value.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"max","details":[{"kind":"html","content":"

The inclusive maximum value.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"min","title":"Minimum","keywords":[],"oneliner":"Determines the minimum of a sequence of values.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Determines the minimum of a sequence of values.

"},{"kind":"example","content":{"body":"
#calc.min(1, -3, -5, 20, 3, 6) \\\n#calc.min("typst", "is", "cool")\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"values","details":[{"kind":"html","content":"

The sequence of values from which to extract the minimum.\nMust not be empty.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["any"],"scope":[]},{"path":["calc"],"name":"max","title":"Maximum","keywords":[],"oneliner":"Determines the maximum of a sequence of values.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Determines the maximum of a sequence of values.

"},{"kind":"example","content":{"body":"
#calc.max(1, -3, -5, 20, 3, 6) \\\n#calc.max("typst", "is", "cool")\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"values","details":[{"kind":"html","content":"

The sequence of values from which to extract the maximum.\nMust not be empty.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["any"],"scope":[]},{"path":["calc"],"name":"even","title":"Even","keywords":[],"oneliner":"Determines whether an integer is even.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Determines whether an integer is even.

"},{"kind":"example","content":{"body":"
#calc.even(4) \\\n#calc.even(5) \\\n#range(10).filter(calc.even)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to check for evenness.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["calc"],"name":"odd","title":"Odd","keywords":[],"oneliner":"Determines whether an integer is odd.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Determines whether an integer is odd.

"},{"kind":"example","content":{"body":"
#calc.odd(4) \\\n#calc.odd(5) \\\n#range(10).filter(calc.odd)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The number to check for oddness.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["calc"],"name":"rem","title":"Remainder","keywords":[],"oneliner":"Calculates the remainder of two numbers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the remainder of two numbers.

\n

The value calc.rem(x, y) always has the same sign as x, and is smaller\nin magnitude than y.

\n

This can error if given a decimal input and the dividend is too small in\nmagnitude compared to the divisor.

"},{"kind":"example","content":{"body":"
#calc.rem(7, 3) \\\n#calc.rem(7, -3) \\\n#calc.rem(-7, 3) \\\n#calc.rem(-7, -3) \\\n#calc.rem(1.75, 0.5)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"dividend","details":[{"kind":"html","content":"

The dividend of the remainder.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"divisor","details":[{"kind":"html","content":"

The divisor of the remainder.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"div-euclid","title":"Euclidean Division","keywords":[],"oneliner":"Performs euclidean division of two numbers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Performs euclidean division of two numbers.

\n

The result of this computation is that of a division rounded to the integer\nn such that the dividend is greater than or equal to n times\nthe divisor.

\n

This can error if the resulting number is larger than the maximum value or\nsmaller than the minimum value for its type.

"},{"kind":"example","content":{"body":"
#calc.div-euclid(7, 3) \\\n#calc.div-euclid(7, -3) \\\n#calc.div-euclid(-7, 3) \\\n#calc.div-euclid(-7, -3) \\\n#calc.div-euclid(1.75, 0.5) \\\n#calc.div-euclid(decimal("1.75"), decimal("0.5"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"dividend","details":[{"kind":"html","content":"

The dividend of the division.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"divisor","details":[{"kind":"html","content":"

The divisor of the division.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"rem-euclid","title":"Euclidean Remainder","keywords":["modulo","modulus"],"oneliner":"This calculates the least nonnegative remainder of a division.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

This calculates the least nonnegative remainder of a division.

\n

Warning: Due to a floating point round-off error, the remainder may equal\nthe absolute value of the divisor if the dividend is much smaller in\nmagnitude than the divisor and the dividend is negative. This only applies\nfor floating point inputs.

\n

In addition, this can error if given a decimal input and the dividend is\ntoo small in magnitude compared to the divisor.

"},{"kind":"example","content":{"body":"
#calc.rem-euclid(7, 3) \\\n#calc.rem-euclid(7, -3) \\\n#calc.rem-euclid(-7, 3) \\\n#calc.rem-euclid(-7, -3) \\\n#calc.rem-euclid(1.75, 0.5) \\\n#calc.rem-euclid(decimal("1.75"), decimal("0.5"))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"dividend","details":[{"kind":"html","content":"

The dividend of the remainder.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"divisor","details":[{"kind":"html","content":"

The divisor of the remainder.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int","float","decimal"],"scope":[]},{"path":["calc"],"name":"quo","title":"Quotient","keywords":[],"oneliner":"Calculates the quotient (floored division) of two numbers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the quotient (floored division) of two numbers.

\n

Note that this function will always return an integer, and will\nerror if the resulting number is larger than the maximum 64-bit signed\ninteger or smaller than the minimum for that type.

"},{"kind":"example","content":{"body":"
$ "quo"(a, b) &= floor(a/b) \\\n  "quo"(14, 5) &= #calc.quo(14, 5) \\\n  "quo"(3.46, 0.5) &= #calc.quo(3.46, 0.5) $\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"dividend","details":[{"kind":"html","content":"

The dividend of the quotient.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"divisor","details":[{"kind":"html","content":"

The divisor of the quotient.

"}],"types":["int","float","decimal"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["int"],"scope":[]},{"path":["calc"],"name":"norm","title":"𝑝-Norm","keywords":[],"oneliner":"Calculates the p-norm of a sequence of values.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the p-norm of a sequence of values.

"},{"kind":"example","content":{"body":"
#calc.norm(1, 2, -3, 0.5) \\\n#calc.norm(p: 3, 1, 2)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"p","details":[{"kind":"html","content":"

The p value to calculate the p-norm of.

"}],"types":["float"],"strings":[],"default":"2.0","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"values","details":[{"kind":"html","content":"

The sequence of values from which to calculate the p-norm.\nReturns 0.0 if empty.

"}],"types":["float"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["float"],"scope":[]}],"global_attributes":[]}}}