summaryrefslogtreecommitdiffstats
path: root/docs/content/functions/math.md
blob: 9a53473ec58f4c8d52b6f521b4813767c3179b72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
---
title: Math
description: Hugo provides six mathematical operators in templates.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
#tags: [math, operators]
categories: [functions]
menu:
  docs:
    parent: "functions"
toc:
signature: []
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
draft: false
aliases: []
---

There are 6 basic mathematical operators that can be used in Hugo templates:

| Function | Description              | Example                       |
| -------- | ------------------------ | ----------------------------- |
| `add`    | Adds two integers.       | `{{add 1 2}}` → 3        |
| `div`    | Divides two integers.    | `{{div 6 3}}` → 2        |
| `mod`    | Modulus of two integers. | `{{mod 15 3}}` → 0       |
| `modBool`| Boolean of modulus of two integers. Evaluates to `true` if = 0. | `{{modBool 15 3}}` → true |
| `mul`    | Multiplies two integers. | `{{mul 2 3}}` → 6        |
| `sub`    | Subtracts two integers.  | `{{sub 3 2}}` → 1        |