# Numeric {% hint style="info" %} You can easily import all the functions from the `numeric` registry by including the following import statement in your code ```go import "github.com/go-sprout/sprout/registry/numeric" ``` {% endhint %} ### floor The function returns the largest integer that is less than or equal to the provided number.

Name	Value
Signature	`Floor(num any) (float64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ 3.7 | floor }} // Output: 3 {{ floor 1.5 }} // Output: 1 {{ floor 123.9999 }} // Output: 123 {{ floor 123.0001 }} // Output: 123 {{ floor "invalid" }} // Error ``` {% endtab %} {% endtabs %} ### ceil The function returns the smallest integer that is greater than or equal to the provided number.

Name	Value
Signature	`Ceil(num any) (float64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ 3.1 | ceil }} // Output: 4 {{ ceil 1.5 }} // Output: 2 {{ ceil 123.9999 }} // Output: 124 {{ ceil 123.0001 }} // Output: 124 {{ ceil "invalid" }} // Error ``` {% endtab %} {% endtabs %} ### round The function rounds a number to a specified precision, allowing control over the number of decimal places. It also considers an optional rounding threshold to determine whether to round up or down (default to 0.5).

Name	Value
Signature	`Round(num any, poww int, roundOpts ...float64) (float64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ round 3.746 2 }} // Output: 3.75 {{ round 3.746 2 0.5 }} // Output: 3.75 {{ round "123.5555" 3 }} // Output: 123.556 {{ round 123.49999999 0 }} // Output: 123 {{ round 123.2329999 2 .3 }} // Output: 123.23 ``` {% endtab %} {% endtabs %} ### add / addf The function performs addition on a slice of values, summing all elements in the slice and returning the total.

Name	Value
Signature	`Add(values ...any) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ add }} // Output: 0 {{ add 1 }} // Output: 1 {{ add 1 2 3 4 5 6 7 8 9 10 }} // Output: 55 {{ add 1.1 2.2 3.3 4.4 5.5 6.6 7.7 8.8 9.9 10.1 }} // Output: 59.6 ``` {% endtab %} {% endtabs %} ### add1 / add1f The function performs a unary addition, incrementing the provided value by one.

Name	Value
Signature	`Add1(x any) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ add1 -1 }} // Output: 0 {{ add1 1 }} // Output: 2 {{ add1 1.1 }} // Output: 2.1 ``` {% endtab %} {% endtabs %} ### sub / subf The function performs subtraction on a slice of values, starting with the first value and subtracting each subsequent value from it.

Name	Value
Signature	`Sub(values ...any) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ sub 10 3 2 }} // Output: 5 ``` {% endtab %} {% endtabs %} ### mul The function multiplies a sequence of values together and returns the result as an `int64`.

Name	Value
Signature	`MulInt(values ...any) (int64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ mul 1 1 }} // Output: 1 {{ mul 1.1 1.1 }} // Output: 1 {{ 3 | mul 14 }} // Output: 42 ``` {% endtab %} {% endtabs %} ### mulf The function multiplies a sequence of values and returns the result as a `float64`.

Name	Value
Signature	`Mulf(values ...any) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ mulf 1.1 1.1 }} // Output: 1.21 ``` {% endtab %} {% endtabs %} ### div The function divides a sequence of values and returns the result as an `int64`.

Name	Value
Signature	`DivInt(values ...any) (int64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ div 1 1 }} // Output: 1 {{ div 1.1 1.1 }} // Output: 1 ``` {% endtab %} {% endtabs %} ### divf The function divides a sequence of values, starting with the first value, and returns the result as a `float64`.

Name	Value
Signature	`Divf(values ...any) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ divf 30.0 3.0 2.0 }} // Output: 5 {{ 2 | divf 5 4 }} // Output: 0.625 ``` {% endtab %} {% endtabs %} ### mod The function returns the remainder of the division of `x` by `y`.

Name	Value
Signature	`Mod(x any, y any) (any, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ 4 | mod 10 }} // Output: 2 ``` {% endtab %} {% endtabs %} ### min The function returns the minimum value among the provided arguments.

Name	Value
Signature	`Min(a any, i ...any) (int64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ min 5 3 8 2 }} // Output: 2 ``` {% endtab %} {% endtabs %} ### minf The function returns the minimum value among the provided floating-point arguments.

Name	Value
Signature	`Minf(a any, i ...any) (float64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ minf 5.2 3.8 8.1 2.6 }} // Output: 2.6 ``` {% endtab %} {% endtabs %} ### max The function returns the maximum value among the provided arguments.

Name	Value
Signature	`Max(a any, i ...any) (int64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ max 5 3 8 2 }} // Output: 8 ``` {% endtab %} {% endtabs %} ### maxf The function returns the maximum value among the provided floating-point arguments.

Name	Value
Signature	`Maxf(a any, i ...any) (float64, error)`

{% tabs %} {% tab title="Template Example" %} ```go {{ maxf 5.2 3.8 8.1 2.6 }} // Output: 8.1 ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.atom.codes/sprout/registries/numeric.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.