Skip to content

Commit

Permalink
tpl/math: Add math.Rand template function
Browse files Browse the repository at this point in the history
Closes #11833
  • Loading branch information
jmooring authored and bep committed Dec 29, 2023
1 parent 175b8aa commit 6ed2e19
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
44 changes: 44 additions & 0 deletions content/en/functions/math/Rand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: math.Rand
description: Returns a pseudo-random number in the half-open interval [0.0, 1.0).
categories: []
keywords: []
action:
aliases: []
related: []
returnType: float64
signatures: [math.Rand]
---

The `math.Rand` function returns a pseudo-random number in the [half-open interval] [0.0, 1.0).

```go-html-template
{{ math.Rand }} → 0.6312770459590062
```

To generate a random integer in the [closed interval] [0, 5]:

```go-html-template
{{ math.Rand | mul 6 | math.Floor }}
```

To generate a random integer in the closed interval [1, 6]:

```go-html-template
{{ math.Rand | mul 6 | math.Ceil }}
```

To generate a random float, with one digit after the decimal point, in the closed interval [0, 4.9]:

```go-html-template
{{ div (math.Rand | mul 50 | math.Floor) 10 }}
```

To generate a random float, with one digit after the decimal point, in the closed interval [0.1, 5.0]:

```go-html-template
{{ div (math.Rand | mul 50 | math.Ceil) 10 }}
```

[closed interval]: /getting-started/glossary/#interval
[half-open interval]: /getting-started/glossary/#interval
10 changes: 10 additions & 0 deletions content/en/getting-started/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@ A numeric data type without a fractional component. For example, `42`.

Software design and development efforts that enable [localization](#localization). See the [W3C definition](https://www.w3.org/International/questions/qa-i18n). Abbreviated i18n.

###### interval

An [interval](https://en.wikipedia.org/wiki/Interval_(mathematics)) is a range of numbers between two endpoints: closed, open, or half-open.

- A _closed_ interval, denoted by brackets, includes its endpoints. For example, [0,&nbsp;1]&nbsp;is the interval where `0 <= x <= 1`.

- An _open_ interval, denoted by parenthesis, excludes its endpoints. For example, (0,&nbsp;1)&nbsp;is the interval where `0 < x < 1`.

- A _half-open_ interval includes only one of its endpoints. For example, (0,&nbsp;1]&nbsp;is the _left-open_ interval where `0 < x <= 1`, while [0,&nbsp;1)&nbsp;is the _right-open_ interval where `0 <= x < 1`.

###### kind

See [page kind](#page-kind).
Expand Down

0 comments on commit 6ed2e19

Please sign in to comment.