Math functions

Math functions available through the object math in scriban.

• math.abs
• math.ceil
• math.divided_by
• math.floor
• math.format
• math.is_number
• math.minus
• math.modulo
• math.plus
• math.round
• math.times
• math.uuid
• math.random

math.absCopy Anchor Link

math.abs <value>

DescriptionCopy Anchor Link

Returns the absolute value of a specified number.

ArgumentsCopy Anchor Link

• value: The input value

ReturnsCopy Anchor Link

The absolute value of the input value

ExamplesCopy Anchor Link

input

{{ -15.5| math.abs }}
{{ -5| math.abs }}

output

15.5 5

math.ceilCopy Anchor Link

math.ceil <value>

DescriptionCopy Anchor Link

Returns the smallest integer greater than or equal to the specified number.

ArgumentsCopy Anchor Link

• value: The input value

ReturnsCopy Anchor Link

The smallest integer greater than or equal to the specified number.

ExamplesCopy Anchor Link

input

{{ 4.6 | math.ceil }}
{{ 4.3 | math.ceil }}

output

5 5

math.divided_byCopy Anchor Link

math.divided_by <value> <divisor>

DescriptionCopy Anchor Link

Divides the specified value by another value. If the divisor is an integer, the result will be floor to and converted back to an integer.

ArgumentsCopy Anchor Link

• value: The input value
• divisor: The divisor value

ReturnsCopy Anchor Link

The division of value by divisor.

ExamplesCopy Anchor Link

input

{{ 8.4 | math.divided_by 2.0 | math.round 1 }}
{{ 8.4 | math.divided_by 2 }}

output

4.2 4

math.floorCopy Anchor Link

math.floor <value>

DescriptionCopy Anchor Link

Returns the largest integer less than or equal to the specified number.

ArgumentsCopy Anchor Link

• value: The input value

ReturnsCopy Anchor Link

The largest integer less than or equal to the specified number.

ExamplesCopy Anchor Link

input

{{ 4.6 | math.floor }}
{{ 4.3 | math.floor }}

output

4 4

math.formatCopy Anchor Link

math.format <value> <format> <culture>?

DescriptionCopy Anchor Link

Formats a number value with specified .NET standard numeric format strings

ArgumentsCopy Anchor Link

• value: The input value
• format: The format string.
• culture: The culture as a string (e.g en-US). By default the culture from is used

ReturnsCopy Anchor Link

The largest integer less than or equal to the specified number.

ExamplesCopy Anchor Link

input

{{ 255 | math.format "X4" }}

output

00FF

math.is_numberCopy Anchor Link

math.is_number <value>

DescriptionCopy Anchor Link

Returns a boolean indicating if the input value is a number

ArgumentsCopy Anchor Link

• value: The input value

ReturnsCopy Anchor Link

true if the input value is a number; otherwise false.

ExamplesCopy Anchor Link

input

{{ 255 | math.is_number }}
{{ "yo" | math.is_number }}
{{ null | math.is_number }}

output

true false false

math.minusCopy Anchor Link

math.minus <value> <with>

DescriptionCopy Anchor Link

Subtracts from the input value the with value

ArgumentsCopy Anchor Link

• value: The input value
• with: The with value to subtract from value

ReturnsCopy Anchor Link

The results of the subtraction: value - with

ExamplesCopy Anchor Link

input

{{ 255 | math.minus 5}}

output

250

math.moduloCopy Anchor Link

math.modulo <value> <with>

DescriptionCopy Anchor Link

Performs the modulo of the input value with the with value

ArgumentsCopy Anchor Link

• value: The input value
• with: The with value to module value

ReturnsCopy Anchor Link

The results of the modulo: value % with

ExamplesCopy Anchor Link

input

{{ 11 | math.modulo 10}}

output

1

math.plusCopy Anchor Link

math.plus <value> <with>

DescriptionCopy Anchor Link

Performs the addition of the input value with the with value

ArgumentsCopy Anchor Link

• value: The input value
• with: The with value to add tovalue

ReturnsCopy Anchor Link

The results of the addition: value + with

ExamplesCopy Anchor Link

input

{{ 1 | math.plus 2}}

output

3

math.roundCopy Anchor Link

math.round <value> <precision: 0>?

DescriptionCopy Anchor Link

Rounds a value to the nearest integer or to the specified number of fractional digits.

ArgumentsCopy Anchor Link

• value: The input value
• precision: The number of fractional digits in the return value. Default is 0.

ReturnsCopy Anchor Link

A value rounded to the nearest integer or to the specified number of fractional digits.

ExamplesCopy Anchor Link

input

{{ 4.6 | math.round }}
{{ 4.3 | math.round }}
{{ 4.5612 | math.round 2 }}

output

5 4 4.56

math.timesCopy Anchor Link

math.times <value> <with>

DescriptionCopy Anchor Link

Performs the multiplication of the input value with the with value

ArgumentsCopy Anchor Link

• value: The input value
• with: The with value to multiply tovalue

ReturnsCopy Anchor Link

The results of the multiplication: value * with

ExamplesCopy Anchor Link

input

{{ 2 | math.times 3}}

output

6

math.uuidCopy Anchor Link

math.uuid

DescriptionCopy Anchor Link

Creates a new UUID

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

The created UUID, ex. 2dc55d50-3f6c-446a-87d0-a5a4eed23269

ExamplesCopy Anchor Link

input

{{ math.uuid }}

output

1c0a4aa8-680e-4bd6-95e9-cdbec45ef057

math.randomCopy Anchor Link

math.random <minValue> <maxValue>

DescriptionCopy Anchor Link

Creates a random number

ArgumentsCopy Anchor Link

• minValue: The inclusive lower bound of the random number returned
• maxValue: The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue.

ReturnsCopy Anchor Link

A random number greater or equal to minValue and less than maxValue

ExamplesCopy Anchor Link

input

{{ math.random 1 10 }}

output

7