# Modulo

Arithmetic modulo operator, returns the remainder from dividing two numbers.

## Number modulo - int

If the lhs and rhs are ints then the expression will be calculated with ints.

Given a sample.yml file of:

```yaml
a: 13
b: 2
```

then

```bash
yq '.a = .a % .b' sample.yml
```

will output

```yaml
a: 1
b: 2
```

## Number modulo - float

If the lhs or rhs are floats then the expression will be calculated with floats.

Given a sample.yml file of:

```yaml
a: 12
b: 2.5
```

then

```bash
yq '.a = .a % .b' sample.yml
```

will output

```yaml
a: !!float 2
b: 2.5
```

## Number modulo - int by zero

If the lhs is an int and rhs is a 0 the result is an error.

Given a sample.yml file of:

```yaml
a: 1
b: 0
```

then

```bash
yq '.a = .a % .b' sample.yml
```

will output

```bash
Error: cannot modulo by 0
```

## Number modulo - float by zero

If the lhs is a float and rhs is a 0 the result is NaN.

Given a sample.yml file of:

```yaml
a: 1.1
b: 0
```

then

```bash
yq '.a = .a % .b' sample.yml
```

will output

```yaml
a: !!float NaN
b: 0
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mikefarah.gitbook.io/yq/operators/modulo.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.