本地聚类系数

词汇表

有向: 有向特征。该算法在有向图上定义良好。
有向: 有向特征。该算法忽略图的方向。
有向: 有向特征。该算法不能在有向图上运行。
无向: 无向特征。该算法在无向图上定义良好。
无向: 无向特征。该算法忽略图的无向性。
异构节点: 异构节点完全支持。该算法能够区分不同类型的节点。
异构节点: 异构节点允许。该算法将所有选定节点视为相同，无论其标签如何。
异构关系: 异构关系完全支持。该算法能够区分不同类型的关系。
异构关系: 异构关系允许。该算法将所有选定关系视为相同，无论其类型如何。
加权关系: 加权特征。该算法支持使用关系属性作为权重，通过 relationshipWeightProperty 配置参数指定。
加权关系: 加权特征。该算法将每个关系视为同等重要，忽略任何关系权重的值。

介绍

本地聚类系数算法计算图中每个节点的本地聚类系数。节点 n 的本地聚类系数 C_n 描述了 n 的邻居也相互连接的可能性。为了计算 C_n，我们使用节点参与的三角形数量 T_n 和节点的度 d_n。计算本地聚类系数的公式如下所示

正如我们所见，三角形计数是计算本地聚类系数所必需的。为此，使用了三角形计数算法。

此外，该算法可以计算整个图的 平均聚类系数。这是所有本地聚类系数的归一化总和。

有关更多信息，请参见聚类系数.

语法

本节介绍在每种执行模式下执行本地聚类系数算法时使用的语法。我们正在描述命名图变体的语法。要了解有关一般语法变体的更多信息，请参见语法概述.

每种模式下的本地聚类系数语法

在命名图上以流模式运行本地聚类系数

CALL gds.localClusteringCoefficient.stream(
  graphName: String,
  configuration: Map
)
YIELD
  nodeId: Integer,
  localClusteringCoefficient: Double

表 1. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`n/a`	否	存储在目录中的图的名称。
configuration	映射	`{}`	是	算法特定配置和/或图过滤。

表 2. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定的节点标签过滤命名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定的关系类型过滤命名图。将包含具有任何给定类型的关系。
concurrency	整数	`4`	是	用于运行算法的并发线程数。
jobId	字符串	`内部生成`	是	可用于更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，则不会记录进度百分比。
triangleCountProperty	字符串	`n/a`	是	包含预计算三角形计数的节点属性。

表 3. 结果
名称	类型	描述
nodeId	整数	节点 ID。
localClusteringCoefficient	双精度	局部聚类系数。

在命名图上以统计模式运行局部聚类系数

CALL gds.localClusteringCoefficient.stats(
  graphName: String,
  configuration: Map
)
YIELD
  averageClusteringCoefficient: Double,
  nodeCount: Integer,
  preProcessingMillis: Integer,
  computeMillis: Integer,
  postProcessingMillis: Integer,
  configuration: Map

表 4. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`n/a`	否	存储在目录中的图的名称。
configuration	映射	`{}`	是	算法特定配置和/或图过滤。

表 5. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定的节点标签过滤命名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定的关系类型过滤命名图。将包含具有任何给定类型的关系。
concurrency	整数	`4`	是	用于运行算法的并发线程数。
jobId	字符串	`内部生成`	是	可用于更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，则不会记录进度百分比。
triangleCountProperty	字符串	`n/a`	是	包含预计算三角形计数的节点属性。

表 6. 结果
名称	类型	描述
averageClusteringCoefficient	双精度	平均聚类系数。
nodeCount	整数	图中的节点数。
preProcessingMillis	整数	预处理图的毫秒数。
computeMillis	整数	运行算法的毫秒数。
postProcessingMillis	整数	计算全局指标的毫秒数。
configuration	映射	用于运行算法的配置。

在命名图上以变异模式运行局部聚类系数

CALL gds.localClusteringCoefficient.mutate(
  graphName: String,
  configuration: Map
)
YIELD
  averageClusteringCoefficient: Double,
  nodeCount: Integer,
  nodePropertiesWritten: Integer,
  preProcessingMillis: Integer,
  computeMillis: Integer,
  postProcessingMillis: Integer,
  mutateMillis: Integer,
  configuration: Map

表 7. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`n/a`	否	存储在目录中的图的名称。
configuration	映射	`{}`	是	算法特定配置和/或图过滤。

表 8. 配置
名称	类型	默认值	可选	描述
mutateProperty	字符串	`n/a`	否	GDS 图中写入局部聚类系数的节点属性。
nodeLabels	字符串列表	`['*']`	是	使用给定的节点标签过滤命名图。
relationshipTypes	字符串列表	`['*']`	是	使用给定的关系类型过滤命名图。
concurrency	整数	`4`	是	用于运行算法的并发线程数。
jobId	字符串	`内部生成`	是	可用于更轻松地跟踪算法进度的 ID。
triangleCountProperty	字符串	`n/a`	是	包含预计算三角形计数的节点属性。

表 9. 结果
名称	类型	描述
averageClusteringCoefficient	双精度	平均聚类系数。
nodeCount	整数	图中的节点数。
nodePropertiesWritten	整数	添加到投影图中的属性数。
preProcessingMillis	整数	预处理图的毫秒数。
computeMillis	整数	运行算法的毫秒数。
postProcessingMillis	整数	计算全局指标的毫秒数。
mutateMillis	整数	将属性添加到投影图中的毫秒数。
configuration	映射	用于运行算法的配置。

在命名图上以写入模式运行局部聚类系数

CALL gds.localClusteringCoefficient.write(
  graphName: String,
  configuration: Map
)
YIELD
  averageClusteringCoefficient: Double,
  nodeCount: Integer,
  nodePropertiesWritten: Integer,
  preProcessingMillis: Integer,
  computeMillis: Integer,
  postProcessingMillis: Integer,
  writeMillis: Integer,
  configuration: Map

表 10. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`n/a`	否	存储在目录中的图的名称。
configuration	映射	`{}`	是	算法特定配置和/或图过滤。

表 11. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定的节点标签过滤命名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定的关系类型过滤命名图。将包含具有任何给定类型的关系。
concurrency	整数	`4`	是	用于运行算法的并发线程数。
jobId	字符串	`内部生成`	是	可用于更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，则不会记录进度百分比。
writeConcurrency	整数	`'concurrency' 的值`	是	用于将结果写入 Neo4j 的并发线程数。
writeProperty	字符串	`n/a`	否	Neo4j 数据库中写入局部聚类系数的节点属性。
triangleCountProperty	字符串	`n/a`	是	包含预计算三角形计数的节点属性。

表 12. 结果
名称	类型	描述
averageClusteringCoefficient	双精度	平均聚类系数。
nodeCount	整数	图中的节点数。
nodePropertiesWritten	整数	写入 Neo4j 的属性数。
preProcessingMillis	整数	预处理图的毫秒数。
computeMillis	整数	运行算法的毫秒数。
postProcessingMillis	整数	计算全局指标的毫秒数。
writeMillis	整数	将结果写回 Neo4j 的毫秒数。
configuration	映射	用于运行算法的配置。

示例

以下所有示例都应在空数据库中运行。

这些示例使用 Cypher 投影作为规范。原生投影将在未来版本中弃用。

在本节中，我们将展示在具体图上运行局部聚类系数算法的示例。目的是说明结果是什么样的，并提供在实际环境中如何使用该算法的指南。我们将在少数节点以特定模式连接的少量社交网络图上执行此操作。示例图如下所示

以下 Cypher 语句将在 Neo4j 数据库中创建示例图

CREATE
  (alice:Person {name: 'Alice'}),
  (michael:Person {name: 'Michael'}),
  (karin:Person {name: 'Karin'}),
  (chris:Person {name: 'Chris'}),
  (will:Person {name: 'Will'}),
  (mark:Person {name: 'Mark'}),

  (michael)-[:KNOWS]->(karin),
  (michael)-[:KNOWS]->(chris),
  (will)-[:KNOWS]->(michael),
  (mark)-[:KNOWS]->(michael),
  (mark)-[:KNOWS]->(will),
  (alice)-[:KNOWS]->(michael),
  (will)-[:KNOWS]->(chris),
  (chris)-[:KNOWS]->(karin)

有了 Neo4j 中的图，我们现在可以将其投影到图目录中以准备算法执行。我们使用针对 Person 节点和 KNOWS 关系的 Cypher 投影来执行此操作。对于关系，我们必须使用 UNDIRECTED 方向。这是因为局部聚类系数算法仅针对无向图定义。

以下语句将使用 Cypher 投影投影图，并将其存储在名为 'myGraph' 的图目录中。

MATCH (source:Person)-[r:KNOWS]->(target:Person)
RETURN gds.graph.project(
  'myGraph',
  source,
  target,
  {},
  { undirectedRelationshipTypes: ['*'] }
)

局部聚类系数算法要求该图使用 UNDIRECTED 方向来表示关系。您可以创建具有无向关系的图，或更新它，将有向关系转换为新的无向关系。

在以下示例中，我们将演示在 'myGraph' 上使用局部聚类系数算法。

内存估算

首先，我们将使用 estimate 过程估算运行算法的成本。这可以使用任何执行模式完成。在本示例中，我们将使用 write 模式。估算算法有助于了解在图上运行算法将产生的内存影响。当您稍后以其中一种执行模式实际运行算法时，系统将执行估算。如果估算表明执行有很大可能超过其内存限制，则会禁止执行。有关此方面的更多信息，请参阅自动估算和执行阻止。

有关 estimate 的更多详细信息，请参阅内存估算。

以下将估算运行算法的内存需求

CALL gds.localClusteringCoefficient.write.estimate('myGraph', {
  writeProperty: 'localClusteringCoefficient'
})
YIELD nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory

表 13. 结果
nodeCount	relationshipCount	bytesMin	bytesMax	requiredMemory
6	16	304	304	"304 字节"

请注意，关系计数为 16，尽管我们在原始 Cypher 语句中只创建了 8 个关系。这是因为我们使用了 UNDIRECTED 方向，这将以每个方向投影每个关系，有效地将关系数量增加一倍。

流

在 stream 执行模式下，算法返回每个节点的局部聚类系数。这使我们能够直接检查结果，或在 Cypher 中对其进行后处理，而不会产生任何副作用。例如，我们可以对结果进行排序以找到具有最高局部聚类系数的节点。

有关 stream 模式的更多详细信息，请参阅流。

以下将在 stream 模式下运行算法

CALL gds.localClusteringCoefficient.stream('myGraph')
YIELD nodeId, localClusteringCoefficient
RETURN gds.util.asNode(nodeId).name AS name, localClusteringCoefficient
ORDER BY localClusteringCoefficient DESC, name

表 14. 结果
name	localClusteringCoefficient
"Karin"	1.0
"Mark"	1.0
"Chris"	0.6666666666666666
"Will"	0.6666666666666666
"Michael"	0.3
"Alice"	0.0

从结果中我们可以看到，节点 'Karin' 和 'Mark' 具有最高的局部聚类系数。这表明他们最善于介绍他们的朋友 - 所有认识他们的人，彼此认识！这可以在示例图中得到验证。

统计

在 stats 执行模式下，算法返回包含算法结果摘要的单个行。摘要结果包含图的平均聚类系数，它是所有局部聚类系数的归一化总和。此执行模式没有任何副作用。它可用于通过检查 computeMillis 返回项来评估算法性能。在以下示例中，我们将省略返回时间。可以在语法部分中找到该过程的完整签名。

有关 stats 模式的更多详细信息，请参阅统计。

以下将在 stats 模式下运行算法

CALL gds.localClusteringCoefficient.stats('myGraph')
YIELD averageClusteringCoefficient, nodeCount

表 15. 结果
averageClusteringCoefficient	nodeCount
0.6055555555555555	6

结果表明，我们的示例图的每个节点平均大约 60% 的邻居相互连接。

变异

mutate 执行模式使用一个重要的副作用扩展了 stats 模式：使用包含该节点的局部聚类系数的新的节点属性更新命名图。新属性的名称使用强制配置参数 mutateProperty 指定。结果是一个与 stats 相似的单个摘要行，但包含一些额外的指标。mutate 模式在将多个算法结合使用时特别有用。

有关 mutate 模式的更多详细信息，请参阅变异。

以下将在 mutate 模式下运行算法

CALL gds.localClusteringCoefficient.mutate('myGraph', {
  mutateProperty: 'localClusteringCoefficient'
})
YIELD averageClusteringCoefficient, nodeCount

表 16. 结果
averageClusteringCoefficient	nodeCount
0.6055555555555555	6

返回的结果与 stats 示例中的相同。此外，图 'myGraph' 现在具有一个名为 localClusteringCoefficient 的节点属性，该属性存储每个节点的局部聚类系数。要了解如何检查内存中图的新架构，请参阅列出图。

写入

write 执行模式使用一个重要的副作用扩展了 stats 模式：将每个节点的局部聚类系数作为属性写入 Neo4j 数据库。新属性的名称使用强制配置参数 writeProperty 指定。结果是一个与 stats 相似的单个摘要行，但包含一些额外的指标。write 模式使能够将结果直接持久化到数据库中。

有关 write 模式的更多详细信息，请参阅写入。

以下将在 write 模式下运行算法

CALL gds.localClusteringCoefficient.write('myGraph', {
  writeProperty: 'localClusteringCoefficient'
})
YIELD averageClusteringCoefficient, nodeCount

表 17. 结果
averageClusteringCoefficient	nodeCount
0.6055555555555555	6

返回的结果与 stats 示例中的相同。此外，这六个节点中的每一个现在在 Neo4j 数据库中都有一个名为 localClusteringCoefficient 的新属性，其中包含该节点的局部聚类系数。

预计算计数

默认情况下，局部聚类系数算法在计算过程中会执行三角形计数。也可以通过配置局部聚类系数算法从节点属性读取三角形计数来避免三角形计数计算。为此，我们指定了`triangleCountProperty`配置参数。请注意，局部聚类系数算法依赖于属性持有实际的三角形计数，而不是其他数字，才能使结果成为实际的局部聚类系数。

为了说明这一点，我们使用三角形计数算法在`mutate`模式下。三角形计数算法会将其结果存储回'myGraph'。也可以使用图投影和节点属性在创建内存图时从 Neo4j 数据库获取属性值。

以下计算三角形计数并将结果存储到内存图中

CALL gds.triangleCount.mutate('myGraph', {
  mutateProperty: 'triangles'
})

以下将使用预先计算的三角形计数在`stream`模式下运行算法

CALL gds.localClusteringCoefficient.stream('myGraph', {
  triangleCountProperty: 'triangles'
})
YIELD nodeId, localClusteringCoefficient
RETURN gds.util.asNode(nodeId).name AS name, localClusteringCoefficient
ORDER BY localClusteringCoefficient DESC, name

表 18. 结果
name	localClusteringCoefficient
"Karin"	1.0
"Mark"	1.0
"Chris"	0.6666666666666666
"Will"	0.6666666666666666
"Michael"	0.3
"Alice"	0.0

正如我们所看到的，结果与stream示例中没有指定`triangleCountProperty`的结果相同。