dgl.DGLGraph.predecessors

DGLGraph.predecessors(v, etype=None)[source]

返回具有指定边类型的特定节点的前驱节点。

如果图中存在类型为 etype 的边 (u, v),则节点 u 是节点 v 的前驱节点。

参数
  • v (int) – 节点 ID。如果图有多种边类型,此 ID 对应于该边类型的目标节点类型。

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

    边类型的名称。允许的类型名称格式为:

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

    • 或者一个 str 边类型名称,如果该名称可以在图中唯一标识一个三元组格式。

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

返回值

节点 v 具有指定边类型的前驱节点。

返回类型

Tensor

示例

以下示例使用 PyTorch 后端。

>>> import dgl
>>> import torch

创建一个同构图。

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

查询节点 1。

>>> g.predecessors(1)
tensor([0, 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.predecessors(1, etype='follows')
tensor([0])

另请参阅

successors