# `mod`

## Description

Returns the remainder after dividing a number by a divisor. Equivalent to the modulus operator (`%`).

## Syntax

Like many functions in DataPrime, `mod` supports [two notations](https://coralogix.com/docs/dataprime/language-reference/functions-reference/index.md), **function** and **method** notation. These interchangeable forms allow flexibility in how you structure expressions.

```dataprime
mod(number: number, divisor: number): number
```

```dataprime
(number: number).mod(divisor: number): number
```

## Arguments

| Name    | Type   | Required | Description                                |
| ------- | ------ | -------- | ------------------------------------------ |
| number  | number | **true** | The value to divide                        |
| divisor | number | **true** | The divisor used for the modulus operation |

## Example

**Use case: Determine if a number is even or odd**

A value is even if dividing it by `2` leaves a remainder of `0`. Otherwise, it is odd.

### Example data

```json
{
    "val": 7
},
{
    "val": 12
}
```

### Example query

```dataprime
create is_even from (mod(val, 2) == 0)
```

```dataprime
create is_even from (val.mod(2) == 0)
```

### Example output

```json
{
    "val": 7,
    "is_even": false
},
{
    "val": 12,
    "is_even": true
}
```
