---
source_url: https://docs.dolphindb.cn/zh/funcs/m/mod.html
fetched_at: 2026-05-19T09:32:15Z
category: funcs
title: mod
sha1: 420f0ad0550305a59af813e8ba814738d0f9caa0
---

# mod

## 语法

`mod(X, Y)`

## 详情

`mod` 表示取模运算。它返回 *X* 和 *Y* 逐个元素相除得到的余数。

- 当 *Y* 是正整数时，结果总是非负的，例如，-10%3 的结果是 2；
- 当 *Y* 是负整数时，结果总是非正的，例如，-10%-3 的结果是 -1。

`mod` 函数常用于数据分组。比如，[5,4,3,3,5,6]%3 是 [2,1,0,0,2,0]，于是数据被分成了三组。

## 参数

**X** 和 **Y** 可以是标量、数据对、向量或矩阵。如果 *X* 或 *Y*
的其中一个是数据对、向量或矩阵，另一个必须是具有相同长度或维度的数据对、向量或矩阵。

## 返回值

当 *X* 和 *Y* 都是标量时，返回一个整型标量。

当 *X* 或 *Y* 是向量时，返回一个整型向量。

当输入是矩阵时，返回一个整型矩阵。

## 例子

```dolphindb
x=1 2 3;
x % 2;
// output: [1,0,1]

2 % x;
// output: [0,0,2]

y=4 5 6;
x mod y;
// output: [1,2,3]

mod(y, x);
// output: [0,1,0]

m=1..6$2:3;
m;
```

| #0 | #1 | #2 |
| --- | --- | --- |
| 1 | 3 | 5 |
| 2 | 4 | 6 |

```dolphindb
m mod 3;
```

| #0 | #1 | #2 |
| --- | --- | --- |
| 1 | 0 | 2 |
| 2 | 1 | 0 |

```dolphindb
x=-1 2 3;
x%-5;
// output: [-1,-3,-2]

-1%5;
// output: 4
```
