math.md (3070B)
1 ---
2 title: Math
3 description: Hugo provides mathematical operators in templates.
4 date: 2017-02-01
5 publishdate: 2017-02-01
6 lastmod: 2020-02-23
7 keywords: [math, operators]
8 categories: [functions]
9 menu:
10 docs:
11 parent: "functions"
12 toc:
13 signature: []
14 workson: []
15 hugoversion:
16 relatedfuncs: []
17 deprecated: false
18 draft: false
19 aliases: []
20 ---
21
22 | Function | Description | Example |
23 |--------------|-----------------------------------------------------------------------------|----------------------------------|
24 | `add` | Adds two numbers. | `{{add 1 2}}` → `3` |
25 | | *If one of the numbers is a float, the result is a float.* | `{{add 1.1 2}}` → `3.1` |
26 | `sub` | Subtracts two numbers. | `{{sub 3 2}}` → `1` |
27 | | *If one of the numbers is a float, the result is a float.* | `{{sub 3 2.5}}` → `0.5` |
28 | `mul` | Multiplies two numbers. | `{{mul 2 3}}` → `6` |
29 | | *If one of the numbers is a float, the result is a float.* | `{{mul 2 3.1}}` → `6.2` |
30 | `div` | Divides two numbers. | `{{div 6 3}}` → `2` |
31 | | | `{{div 6 4}}` → `1` |
32 | | *If one of the numbers is a float, the result is a float.* | `{{div 6 4.0}}` → `1.5` |
33 | `mod` | Modulus of two integers. | `{{mod 15 3}}` → `0` |
34 | `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{modBool 15 3}}` → `true` |
35 | `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{math.Ceil 2.1}}` → `3` |
36 | `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{math.Floor 1.9}}` → `1` |
37 | `math.Log` | Returns the natural logarithm of the given number. | `{{math.Log 42}}` → `3.737` |
38 | `math.Max` | Returns the greater of two numbers. | `{{math.Max 1 2}}` → `2` |
39 | `math.Min` | Returns the smaller of two numbers. | `{{math.Min 1 2}}` → `1` |
40 | `math.Pow` | Returns the first number raised to the power of the second number. | `{{math.Pow 2 3}}` → `8` |
41 | `math.Round` | Returns the nearest integer, rounding half away from zero. | `{{math.Round 1.5}}` → `2` |
42 | `math.Sqrt` | Returns the square root of the given number. | `{{math.Sqrt 81}}` → `9` |