shithub: hugo

ref: d57be113243be4b76310d4476fbb7525d1452658
dir: /docs/content/en/functions/math.md/

View raw version
---
title: Math
description: Hugo provides nine mathematical operators in templates.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-02-23
keywords: [math, operators]
categories: [functions]
menu:
  docs:
    parent: "functions"
toc:
signature: []
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
draft: false
aliases: []
---

| Function     | Description                                                                 | Example                          |
|--------------|-----------------------------------------------------------------------------|----------------------------------|
| `add`        | Adds two numbers.                                                           | `{{add 1 2}}` → `3`         |
|              | *If one of the numbers is a float, the result is a float.*                  | `{{add 1.1 2}}` → `3.1`     |
| `sub`        | Subtracts two numbers.                                                      | `{{sub 3 2}}` → `1`         |
|              | *If one of the numbers is a float, the result is a float.*                  | `{{sub 3 2.5}}` → `0.5`     |
| `mul`        | Multiplies two numbers.                                                     | `{{mul 2 3}}` → `6`         |
|              | *If one of the numbers is a float, the result is a float.*                  | `{{mul 2 3.1}}` → `6.2`     |
| `div`        | Divides two numbers.                                                        | `{{div 6 3}}` → `2`         |
|              |                                                                             | `{{div 6 4}}` → `1`         |
|              | *If one of the numbers is a float, the result is a float.*                  | `{{div 6 4.0}}` → `1.5`     |
| `mod`        | Modulus of two integers.                                                    | `{{mod 15 3}}` → `0`        |
| `modBool`    | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{modBool 15 3}}` → `true` |
| `math.Ceil`  | Returns the least integer value greater than or equal to the given number.  | `{{math.Ceil 2.1}}` → `3`   |
| `math.Floor` | Returns the greatest integer value less than or equal to the given number.  | `{{math.Floor 1.9}}` → `1`  |
| `math.Round` | Returns the nearest integer, rounding half away from zero.                  | `{{math.Round 1.5}}` → `2`  |
| `math.Log`   | Returns the natural logarithm of the given number.                          | `{{math.Log 42}}` → `3.737` |
| `math.Sqrt`  | Returns the square root of the given number.                                | `{{math.Sqrt 81}}` → `9`    |
| `math.Pow`   | Returns the first number raised to the power of the second number.          | `{{math.Pow 2 3}}` → `8`    |