summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/math.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-05-04 09:44:59 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-05-04 09:44:59 +0200
commit914cc85e22af2e6c28f24a5fc70de94e4b9f1b1b (patch)
treee7b5fcc856003415c613312c80ba2f301eeae03c /docs/content/en/functions/math.md
parenta6816db77574ba3d48a6414c97a53a691c34e705 (diff)
parent83bef6955e014d40c0f00db9cebe09113154e999 (diff)
downloadhugo-914cc85e22af2e6c28f24a5fc70de94e4b9f1b1b.tar.gz
hugo-914cc85e22af2e6c28f24a5fc70de94e4b9f1b1b.zip
Merge commit '83bef6955e014d40c0f00db9cebe09113154e999'
Diffstat (limited to 'docs/content/en/functions/math.md')
-rw-r--r--docs/content/en/functions/math.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/content/en/functions/math.md b/docs/content/en/functions/math.md
new file mode 100644
index 000000000..eb38fdd0b
--- /dev/null
+++ b/docs/content/en/functions/math.md
@@ -0,0 +1,38 @@
+---
+title: Math
+description: Hugo provides nine mathematical operators in templates.
+godocref:
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-02-01
+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}}` &rarr; `3` |
+| | *If one of the numbers is a float, the result is a float.* | `{{add 1.1 2}}` &rarr; `3.1` |
+| `sub` | Subtracts two numbers. | `{{sub 3 2}}` &rarr; `1` |
+| | *If one of the numbers is a float, the result is a float.* | `{{sub 3 2.5}}` &rarr; `0.5` |
+| `mul` | Multiplies two numbers. | `{{mul 2 3}}` &rarr; `6` |
+| | *If one of the numbers is a float, the result is a float.* | `{{mul 2 3.1}}` &rarr; `6.2` |
+| `div` | Divides two numbers. | `{{div 6 3}}` &rarr; `2` |
+| | | `{{div 6 4}}` &rarr; `1` |
+| | *If one of the numbers is a float, the result is a float.* | `{{div 6 4.0}}` &rarr; `1.5` |
+| `mod` | Modulus of two integers. | `{{mod 15 3}}` &rarr; `0` |
+| `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{modBool 15 3}}` &rarr; `true` |
+| `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{math.Ceil 2.1}}` &rarr; `3` |
+| `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{math.Floor 1.9}}` &rarr; `1` |
+| `math.Round` | Returns the nearest integer, rounding half away from zero. | `{{math.Round 1.5}}` &rarr; `2` |