Source: https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/k_core/
Documentation version: v5.3.2

# K-Core

本文介绍 K-Core 算法，并演示如何用 GQL 实现该算法。

## 算法介绍

K-Core 通过迭代剥离低度点，得到每个点度至少为 K 的极大子图。

该过程将算法逻辑封装为可复用过程，可直接在图数据上执行并输出结果。

更多信息，请参见 [K-Core](https://en.wikipedia.org/wiki/Degeneracy_(graph_theory))。

## 数据模型

为了在 GQL 中实现 K-Core 算法，使用以下数据模型创建图类型：

- 实体由类型为`Node`的点表示，点属性包括`id`和`rating`。
- 实体间关系由类型为`Link`的边表示，边属性包括`weight`。

该图类型的完整定义，请参见[准备图数据](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/k_core/#1_prepare_graph_data)。

## 过程实现[]()

为了计算 K-Core 结果，创建一个[过程](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/procedures/create/)。

关于该过程的更多信息，请参见[过程实现](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/k_core/#procedure_implement)。下文将介绍该过程的关键组成部分及其工作原理。

该过程接受以下输入参数：

- `k`：`INT64`类型。 最小度数阈値：仅保留度数≥ k 的点。

此外，在过程内部定义了以下变量：

 | 变量名 | 变量类型 | 描述
 | `frontier` | [原始值变量](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/variable-definition/value-variable/) | 当前剥离步骤中正在处理的活跃点集合。
 | `has_active` | [原始值变量](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/variable-definition/value-variable/) | 是否仍有点处于活跃状态需要被剥离。
 | `degree` | 点绑定 [SumAgg 聚合值变量](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/variable-definition/agg/sum_agg/) | 每点的剩余度数，随邻居被剥离而递减。
 | `alive` | 点绑定 [SumAgg 聚合值变量](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/variable-definition/agg/sum_agg/) | 每点标志，表示该点在当前 k 阈值下存活。
 | `result_table` | [表变量](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/variable-definition/table-variable/) | 存储存活点 (vertex_id, degree) 对的输出表。

以下步骤概述了该过程的逻辑：

1. 将所有点标记为`alive`，并将每个点的`degree`设为其实际度数。
2. 迭代剥离度数低于阈值`k`的点；点被移除时递减其邻居的`degree`。
3. 重复执行直至没有点再被移除（`has_active`为 false）。
4. 返回构成 k-core 的存活点（`vertex_id`、`degree`）。

## 操作步骤

在悦数图管理的控制台中，按顺序执行以下代码块。首次使用时，先按[准备算法示例数据](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/prepare-data/)确认操作位置和目录挂载。

### 1. 准备图数据[]()

1. 

创建一个与数据模型匹配的图类型。

````
'''
CREATE GRAPH TYPE IF NOT EXISTS k_core_graph_type AS {
    NODE Node (LABEL Node {id INT PRIMARY KEY, rating INT}),
    EDGE Link (Node)-[LABEL Link {weight INT, MULTIEDGE KEY()}]->(Node)
}
'''

````

2. 

下载以下 CSV 文件，保留文件名，保存到部署目录下的`examples/algorithms/k_core/`：

  - [k_core_node.csv](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/files/k_core/k_core_node.csv)：点数据。
  - [k_core_edge.csv](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/files/k_core/k_core_edge.csv)：边数据。

查看 CSV 内容

k_core_node.csv

````
id,rating
1,0
2,2
3,1
4,0
5,0
6,2
7,1
8,2
9,0
10,1
11,0
12,2
13,1
14,1
15,0
16,2
17,0
18,1
19,2
20,0
21,2
22,1
23,0
24,1

````

k_core_edge.csv

````
src_id,dst_id,weight
1,2,4
1,3,2
1,4,7
1,5,9
2,3,1
2,4,6
2,5,5
2,6,2
3,4,3
3,5,4
3,6,8
4,6,2
4,7,6
4,8,5
5,6,4
5,8,7
5,9,6
6,8,1
6,9,5
6,10,6
7,9,2
7,10,9
8,9,3
8,11,6
8,12,4
9,10,4
9,12,7
9,13,2
10,12,1
10,13,8
10,14,4
11,12,2
11,14,5
11,15,7
12,14,3
12,15,6
12,16,5
13,15,2
13,16,7
14,15,4
14,17,8
14,18,2
15,16,1
15,18,5
15,19,3
16,18,3
16,19,6
17,18,2
17,20,7
17,21,5
18,19,4
18,21,9
18,22,6
19,21,1
19,22,5
20,21,3
20,23,6
20,24,8
21,22,2
21,23,4
21,24,7
22,24,4
23,24,1

````

3. 

基于图类型创建临时图，并将数据文件加载到临时图中。

````
CREATE TEMPORARY GRAPH IF NOT EXISTS #k_core_graph TYPED k_core_graph_type

````

````
'''
USE #k_core_graph IMPORT INTO GRAPH {
      NODE (v@Node {id: id, rating: rating}) FROM DATAFILE {
          PATH: "file:///examples/algorithms/k_core/k_core_node.csv",
          FORMAT: "CSV",
          DELIMITER: ','
      },
      EDGE (id: src_id)-[e@Link {weight: weight}]->(id: dst_id) FROM DATAFILE {
          PATH: "file:///examples/algorithms/k_core/k_core_edge.csv",
          FORMAT: "CSV",
          DELIMITER: ','
      }
  }
'''

````

导入成功后，在控制台执行以下查询核对点数：

````
'''
USE #k_core_graph
MATCH (n)
RETURN count(n) AS node_count
'''

````

`node_count`应为`24`。点数不符时，先按[文件问题排查](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/prepare-data/#troubleshooting)检查文件和导入结果。

### 2. 创建过程[]()

创建实现 K-Core 算法的过程。关于该过程的更多信息，请参见[过程实现](https://dev-docs.yueshu.com.cn/v5.3.2/analytic/algorithms/k_core/#procedure_implement)。 

````
'''
CREATE OR REPLACE PROCEDURE k_core(k INT64)
RETURNS (vertex_id INT64, degree INT64)
COMMENT "Iteratively peel vertices whose undirected degree is less than k and return the remaining k-core vertices."
AS {
  VALUE frontier ACTIVE_SET
  VALUE has_active OrAgg = false

  NODE VALUE degree SumAgg<INT64> = 0
  NODE VALUE alive OrAgg = false

  TABLE result_table TYPED TABLE {vertex_id INT64, degree INT64}

  MATCH (s)
  PER NODE (s) {
    SET s.@alive = true
  }

  MATCH (s)-[e]-(t)
  PER PATH {
    SET s.@degree += 1
  }

  MATCH (s)
  WHERE s.@degree < k
  PER NODE (s) {
    SET s.@alive = false
    SET @has_active += true
  }
  FINALLY {
    SET frontier = s
  }

  WHILE @has_active = true THEN {
    SET @has_active = false

    MATCH (s)-[e]-(t)
    WHERE s IN frontier AND t.@alive = true
    PER PATH {
      SET t.@degree += -1
    }

    MATCH (t)
    WHERE t.@alive = true AND t.@degree < k
    PER NODE (t) {
      SET t.@alive = false
      SET @has_active += true
    }
    FINALLY {
      SET frontier = t
    }
  }

  MATCH (s)
  WHERE s.@alive = true
  PER NODE (s) {
    EXPORT s.id, s.@degree INTO result_table
  }

  FOR r IN result_table
  RETURN r.vertex_id AS vertex_id, r.degree AS degree
  ORDER BY degree DESC, vertex_id ASC
}
'''

````

### 3. 调用过程[]()

将`k`设为`3`，返回保留在 K-Core 中的点及其度。

````
USE #k_core_graph CALL k_core(3) RETURN vertex_id, degree

````

返回：

展开查看返回

````
+-----------+--------+
| vertex_id | degree |
+-----------+--------+
| 6         | 7      |
| 9         | 7      |
| 12        | 7      |
| 15        | 7      |
| 18        | 7      |
| 21        | 7      |
| 4         | 6      |
| 5         | 6      |
| 8         | 6      |
| 10        | 6      |
| 14        | 6      |
| 2         | 5      |
| 3         | 5      |
| 16        | 5      |
| 19        | 5      |
| 1         | 4      |
| 11        | 4      |
| 13        | 4      |
| 17        | 4      |
| 20        | 4      |
| 22        | 4      |
| 24        | 4      |
| 7         | 3      |
| 23        | 3      |
+-----------+--------+

````

保存结果到文件或图中

如需将返回的结果保存为 CSV 文件或写入图，请参见 [EXPORT](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/in-out/export/)。导出字段应与返回列及目标属性对应。