dgl.DGLGraph.out_edges
- DGLGraph.out_edges(u, form='uv', etype=None)[source]
返回给定节点的出边。
- 参数:
u (节点 ID(s)) –
节点 ID。允许的格式有
int: 单个节点。Int Tensor: 每个元素都是一个节点 ID。该张量必须具有与图相同的设备类型和 ID 数据类型。
iterable[int]: 每个元素都是一个节点 ID。
form (str, 可选) –
返回形式，可以是以下之一
'eid': 返回结果是一个 1D 张量 \(EID\)，表示所有边的 ID。'uv'(默认): 返回结果是一个由两个 1D 张量组成的 2 元组 \((U, V)\)，表示所有边的源节点和目标节点。对于每个 \(i\)，\((U[i], V[i])\) 形成一条边。'all': 返回结果是一个由三个 1D 张量组成的 3 元组 \((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 和 2。
>>> g.out_edges(torch.tensor([1, 2])) (tensor([1, 1]), tensor([2, 3]))
为
form指定不同的值。>>> g.out_edges(torch.tensor([1, 2]), form='all') (tensor([1, 1]), tensor([2, 3]), tensor([2, 3]))
对于具有多种边类型的图，查询时需要指定边类型。
>>> 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_edges(torch.tensor([1, 2]), etype='follows') (tensor([1]), tensor([2]))