dgl.DGLGraph.out_degrees

DGLGraph.out_degrees(u='__ALL__', etype=None)

返回给定节点的出度。

它计算根据给定边类型的边的出度。

参数:

• u (节点 ID) –

  节点 ID。允许的格式有

  • int：单个节点。

  • Int Tensor：每个元素都是一个节点 ID。张量必须具有与图相同的设备类型和 ID 数据类型。

  • iterable[int]：每个元素都是一个节点 ID。

  如果未给定，则返回所有节点的入度。

• etype (str 或 (str, str, str), 可选) –

  边的类型名称。允许的类型名称格式有

  • (str, str, str) 分别代表源节点类型、边类型和目标节点类型。

  • 如果名称在图中能唯一标识一个三元组格式，则可以是单个 str 边类型名称。

  如果图只有一种边类型，则可以省略。

返回值:

节点(s) 的出度，存储在 Tensor 中。第 i 个元素是第 i 个输入节点的出度。如果输入的 u 是 int 类型，则也返回 int 类型。

返回类型:

int 或 Tensor

示例

以下示例使用 PyTorch 后端。

>>> import dgl
>>> import torch

创建一个同构图。

>>> g = dgl.graph((torch.tensor([0, 0, 1, 1]), torch.tensor([1, 1, 2, 3])))

查询所有节点。

>>> g.out_degrees()
tensor([2, 2, 0, 0])

查询节点 1 和 2。

>>> g.out_degrees(torch.tensor([1, 2]))
tensor([2, 0])

对于具有多种边类型的图，查询时需要指定边类型。

>>> hg = dgl.heterograph({
...     ('user', 'follows', 'user'): (torch.tensor([0, 1]), torch.tensor([1, 2])),
...     ('user', 'plays', 'game'): (torch.tensor([3, 4]), torch.tensor([5, 6]))
... })
>>> hg.out_degrees(torch.tensor([1, 0]), etype='follows')
tensor([1, 1])

另请参见

in_degrees