dgl.DGLGraph.in_edges
- DGLGraph.in_edges(v, form='uv', etype=None)[源码]
返回给定节点的入边。
- 参数:
v (节点 ID(s)) –
节点 ID。允许的格式包括：
int: 单个节点。Int Tensor: 每个元素是一个节点 ID。此张量必须与图具有相同的设备类型和 ID 数据类型。
iterable[int]: 每个元素是一个节点 ID。
form (str, 可选) –
结果格式，可以是以下之一：
'eid': 返回的结果是一个 1D 张量 \(EID\)，表示所有边的 ID。'uv'(默认): 返回的结果是一个包含两个 1D 张量的元组 \((U, V)\)，表示所有边的源节点和目标节点。对于每个 \(i\)，\((U[i], V[i])\) 构成一条边。'all': 返回的结果是一个包含三个 1D 张量的元组 \((U, V, EID)\)，表示所有边的源节点、目标节点和 ID。对于每个 \(i\)，\((U[i], V[i])\) 构成一条 ID 为 \(EID[i]\) 的边。
etype (str 或 (str, str, str), 可选) –
边的类型名称。允许的类型名称格式包括：
(str, str, str)表示源节点类型、边类型和目标节点类型。或者一个
str边类型名称，如果该名称可以在图中唯一标识一个三元组格式。
如果图只有一种边类型，则可以省略。
- 返回:
指定类型的节点的所有入边。有关返回结果的描述，请参见
form的描述。- 返回类型:
Tensor 或 (Tensor, Tensor) 或 (Tensor, Tensor, Tensor)
示例
以下示例使用 PyTorch 后端。
>>> import dgl >>> import torch
创建一个同构图。
>>> g = dgl.graph((torch.tensor([0, 0, 1, 1]), torch.tensor([1, 0, 2, 3])))
查询节点 1 和 0。
>>> g.in_edges(torch.tensor([1, 0])) (tensor([0, 0]), tensor([1, 0]))
为
form指定不同的值。>>> g.in_edges(torch.tensor([1, 0]), form='all') (tensor([0, 0]), tensor([1, 0]), tensor([0, 1]))
对于具有多种边类型的图，在查询时需要指定边类型。
>>> 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.in_edges(torch.tensor([1, 0]), etype='follows') (tensor([0]), tensor([1]))