Merge branch 'master' of github.com:krahets/hello-algo

codes/c/chapter_array_and_linkedlist/CMakeLists.txt

@@ -1 +1,2 @@
 add_executable(array array.c)
+add_executable(linked_list linked_list.c)

codes/c/chapter_array_and_linkedlist/linked_list.c

@@ -0,0 +1,88 @@
+/**
+ * File: linked_list.c
+ * Created Time: 2022-01-12
+ * Author: Zero (glj0@outlook.com)
+ */
+
+#include "../include/include.h"
+
+/* 在链表的结点 n0 之后插入结点 P */
+void insert(ListNode* n0, ListNode* P) {
+    ListNode *n1 = n0->next;
+    n0->next = P;
+    P->next = n1;
+}
+
+/* 删除链表的结点 n0 之后的首个结点 */
+// 由于引入了 stdio.h ，此处无法使用 remove 关键词
+// 详见 https://github.com/krahets/hello-algo/pull/244#discussion_r1067863888
+void removeNode(ListNode* n0) {
+    if (!n0->next)
+        return;
+    // n0 -> P -> n1
+    ListNode *P = n0->next;
+    ListNode *n1 = P->next;
+    n0->next = n1;
+    // 释放内存
+    free(P);
+}
+
+/* 访问链表中索引为 index 的结点 */
+ListNode* access(ListNode* head, int index) {
+    while (head && head->next && index) {
+        head = head->next;
+        index--;
+    }
+    return head;
+}
+
+/* 在链表中查找值为 target 的首个结点 */
+int find(ListNode* head, int target) {
+    int index = 0;
+    while (head) {
+        if (head->val == target)
+            return index;
+        head = head->next;
+        index++;
+    }
+    return -1;
+}
+
+
+/* Driver Code */
+int main() {
+    /* 初始化链表 */
+    // 初始化各个结点 
+    ListNode* n0 = newListNode(1);
+    ListNode* n1 = newListNode(3);
+    ListNode* n2 = newListNode(2);
+    ListNode* n3 = newListNode(5);
+    ListNode* n4 = newListNode(4);
+    // 构建引用指向
+    n0->next = n1;
+    n1->next = n2;
+    n2->next = n3;
+    n3->next = n4;
+    printf("初始化的链表为\r\n"); 
+    printLinkedList(n0);
+
+    /* 插入结点 */
+    insert(n0, newListNode(0));
+    printf("插入结点后的链表为\r\n");
+    printLinkedList(n0);
+
+    /* 删除结点 */
+    removeNode(n0);
+    printf("删除结点后的链表为\r\n");
+    printLinkedList(n0);
+
+    /* 访问结点 */
+    ListNode* node = access(n0, 3);
+    printf("链表中索引 3 处的结点的值 = %d\r\n", node->val);
+
+    /* 查找结点 */
+    int index = find(n0, 2);
+    printf("链表中值为 2 的结点的索引 = %d\r\n", index);
+
+    return 0;
+}

codes/go/chapter_heap/heap.go

@@ -0,0 +1,45 @@
+// File: intHeap.go
+// Created Time: 2023-01-12
+// Author: Reanon (793584285@qq.com)
+
+package chapter_heap
+
+// Go 语言中可以通过实现 heap.Interface 来构建整数大顶堆
+// 实现 heap.Interface 需要同时实现 sort.Interface
+type intHeap []any
+
+// Push heap.Interface 的方法，实现推入元素到堆
+func (h *intHeap) Push(x any) {
+	// Push 和 Pop 使用 pointer receiver 作为参数
+	// 因为它们不仅会对切片的内容进行调整，还会修改切片的长度。
+	*h = append(*h, x.(int))
+}
+
+// Pop heap.Interface 的方法，实现弹出堆顶元素
+func (h *intHeap) Pop() any {
+	// 待出堆元素存放在最后
+	last := (*h)[len(*h)-1]
+	*h = (*h)[:len(*h)-1]
+	return last
+}
+
+// Len sort.Interface 的方法
+func (h *intHeap) Len() int {
+	return len(*h)
+}
+
+// Less sort.Interface 的方法
+func (h *intHeap) Less(i, j int) bool {
+	// 如果实现小顶堆，则需要调整为小于号
+	return (*h)[i].(int) > (*h)[j].(int)
+}
+
+// Swap sort.Interface 的方法
+func (h *intHeap) Swap(i, j int) {
+	(*h)[i], (*h)[j] = (*h)[j], (*h)[i]
+}
+
+// Top 获取堆顶元素
+func (h *intHeap) Top() any {
+	return (*h)[0]
+}

codes/go/chapter_heap/heap_test.go

@@ -0,0 +1,90 @@
+// File: heap_test.go
+// Created Time: 2023-01-12
+// Author: Reanon (793584285@qq.com)
+
+package chapter_heap
+
+import (
+	"container/heap"
+	"fmt"
+	"testing"
+
+	. "github.com/krahets/hello-algo/pkg"
+)
+
+func testPush(h *intHeap, val int) {
+	// 调用 heap.Interface 的方法，来添加元素
+	heap.Push(h, val)
+	fmt.Printf("\n元素 %d 入堆后 \n", val)
+	PrintHeap(*h)
+}
+
+func testPop(h *intHeap) {
+	// 调用 heap.Interface 的方法，来移除元素
+	val := heap.Pop(h)
+	fmt.Printf("\n堆顶元素 %d 出堆后 \n", val)
+	PrintHeap(*h)
+}
+
+func TestHeap(t *testing.T) {
+	/* 初始化堆 */
+	// 初始化大顶堆
+	maxHeap := &intHeap{}
+	heap.Init(maxHeap)
+	/* 元素入堆 */
+	testPush(maxHeap, 1)
+	testPush(maxHeap, 3)
+	testPush(maxHeap, 2)
+	testPush(maxHeap, 5)
+	testPush(maxHeap, 4)
+
+	/* 获取堆顶元素 */
+	top := maxHeap.Top()
+	fmt.Printf("堆顶元素为 %d\n", top)
+
+	/* 堆顶元素出堆 */
+	testPop(maxHeap)
+	testPop(maxHeap)
+	testPop(maxHeap)
+	testPop(maxHeap)
+	testPop(maxHeap)
+
+	/* 获取堆大小 */
+	size := len(*maxHeap)
+	fmt.Printf("堆元素数量为 %d\n", size)
+
+	/* 判断堆是否为空 */
+	isEmpty := len(*maxHeap) == 0
+	fmt.Printf("堆是否为空 %t\n", isEmpty)
+}
+
+func TestMyHeap(t *testing.T) {
+	/* 初始化堆 */
+	// 初始化大顶堆
+	maxHeap := newMaxHeap([]any{9, 8, 6, 6, 7, 5, 2, 1, 4, 3, 6, 2})
+	fmt.Printf("输入数组并建堆后\n")
+	maxHeap.print()
+
+	/* 获取堆顶元素 */
+	peek := maxHeap.peek()
+	fmt.Printf("\n堆顶元素为 %d\n", peek)
+
+	/* 元素入堆 */
+	val := 7
+	maxHeap.push(val)
+	fmt.Printf("\n元素 %d 入堆后\n", val)
+	maxHeap.print()
+
+	/* 堆顶元素出堆 */
+	peek = maxHeap.poll()
+	fmt.Printf("\n堆顶元素 %d 出堆后\n", peek)
+	maxHeap.print()
+
+	/* 获取堆大小 */
+	size := maxHeap.size()
+	fmt.Printf("\n堆元素数量为 %d\n", size)
+
+	/* 判断堆是否为空 */
+	isEmpty := maxHeap.isEmpty()
+	fmt.Printf("\n堆是否为空 %t\n", isEmpty)
+}

codes/go/chapter_heap/my_heap.go

@@ -0,0 +1,139 @@
+// File: my_heap.go
+// Created Time: 2023-01-12
+// Author: Reanon (793584285@qq.com)
+
+package chapter_heap
+
+import (
+	"fmt"
+
+	. "github.com/krahets/hello-algo/pkg"
+)
+
+type maxHeap struct {
+	// 使用切片而非数组，这样无需考虑扩容问题
+	data []any
+}
+
+/* 构造函数，建立空堆 */
+func newHeap() *maxHeap {
+	return &maxHeap{
+		data: make([]any, 0),
+	}
+}
+
+/* 构造函数，根据切片建堆 */
+func newMaxHeap(nums []any) *maxHeap {
+	// 所有元素入堆
+	h := &maxHeap{data: nums}
+	for i := len(h.data) - 1; i >= 0; i-- {
+		// 堆化除叶结点以外的其他所有结点
+		h.siftDown(i)
+	}
+	return h
+}
+
+/* 获取左子结点索引 */
+func (h *maxHeap) left(i int) int {
+	return 2*i + 1
+}
+
+/* 获取右子结点索引 */
+func (h *maxHeap) right(i int) int {
+	return 2*i + 2
+}
+
+/* 获取父结点索引 */
+func (h *maxHeap) parent(i int) int {
+	// 向下整除
+	return (i - 1) / 2
+}
+
+/* 交换元素 */
+func (h *maxHeap) swap(i, j int) {
+	h.data[i], h.data[j] = h.data[j], h.data[i]
+}
+
+/* 获取堆大小 */
+func (h *maxHeap) size() int {
+	return len(h.data)
+}
+
+/* 判断堆是否为空 */
+func (h *maxHeap) isEmpty() bool {
+	return len(h.data) == 0
+}
+
+/* 访问堆顶元素 */
+func (h *maxHeap) peek() any {
+	return h.data[0]
+}
+
+/* 元素入堆 */
+func (h *maxHeap) push(val any) {
+	// 添加结点
+	h.data = append(h.data, val)
+	// 从底至顶堆化
+	h.siftUp(len(h.data) - 1)
+}
+
+/* 从结点 i 开始，从底至顶堆化 */
+func (h *maxHeap) siftUp(i int) {
+	for true {
+		// 获取结点 i 的父结点
+		p := h.parent(i)
+		// 当“越过根结点”或“结点无需修复”时，结束堆化
+		if p < 0 || h.data[i].(int) <= h.data[p].(int) {
+			break
+		}
+		// 交换两结点
+		h.swap(i, p)
+		// 循环向上堆化
+		i = p
+	}
+}
+
+/* 元素出堆 */
+func (h *maxHeap) poll() any {
+	// 判空处理
+	if h.isEmpty() {
+		fmt.Println("error")
+	}
+	// 交换根结点与最右叶结点（即交换首元素与尾元素）
+	h.swap(0, h.size()-1)
+	// 删除结点
+	val := h.data[len(h.data)-1]
+	h.data = h.data[:len(h.data)-1]
+	// 从顶至底堆化
+	h.siftDown(0)
+
+	// 返回堆顶元素
+	return val
+}
+
+/* 从结点 i 开始，从顶至底堆化 */
+func (h *maxHeap) siftDown(i int) {
+	for true {
+		// 判断结点 i, l, r 中值最大的结点，记为 max
+		l, r, max := h.left(i), h.right(i), i
+		if l < h.size() && h.data[l].(int) > h.data[max].(int) {
+			max = l
+		}
+		if r < h.size() && h.data[r].(int) > h.data[max].(int) {
+			max = r
+		}
+		// 若结点 i 最大或索引 l, r 越界，则无需继续堆化，跳出
+		if max == i {
+			break
+		}
+		// 交换两结点
+		h.swap(i, max)
+		// 循环向下堆化
+		i = max
+	}
+}
+
+/* 打印堆（二叉树） */
+func (h *maxHeap) print() {
+	PrintHeap(h.data)
+}

codes/go/pkg/print_utils.go

@@ -29,6 +29,22 @@ func PrintList(list *list.List) {
 	fmt.Print(e.Value, "]\n")
 }
 
+// PrintMap Print a hash map
+func PrintMap[K comparable, V any](m map[K]V) {
+	for key, value := range m {
+		fmt.Println(key, "->", value)
+	}
+}
+
+// PrintHeap Print a heap
+func PrintHeap(h []any) {
+	fmt.Printf("堆的数组表示：")
+	fmt.Printf("%v", h)
+	fmt.Printf("\n堆的树状表示：\n")
+	root := ArrToTree(h)
+	PrintTree(root)
+}
+
 // PrintLinkedList Print a linked list
 func PrintLinkedList(node *ListNode) {
 	if node == nil {
@@ -97,10 +113,3 @@ func showTrunk(t *trunk) {
 	showTrunk(t.prev)
 	fmt.Print(t.str)
 }
-
-// PrintMap Print a hash map
-func PrintMap[K comparable, V any](m map[K]V) {
-	for key, value := range m {
-		fmt.Println(key, "->", value)
-	}
-}

docs/chapter_heap/heap.md

@@ -97,7 +97,80 @@ comments: true
 === "Go"
 
     ```go title="heap.go"
+    // Go 语言中可以通过实现 heap.Interface 来构建整数大顶堆
+    // 实现 heap.Interface 需要同时实现 sort.Interface
+    type intHeap []any
+
+    // Push heap.Interface 的方法，实现推入元素到堆
+    func (h *intHeap) Push(x any) {
+        // Push 和 Pop 使用 pointer receiver 作为参数
+        // 因为它们不仅会对切片的内容进行调整，还会修改切片的长度。
+        *h = append(*h, x.(int))
+    }
+
+    // Pop heap.Interface 的方法，实现弹出堆顶元素
+    func (h *intHeap) Pop() any {
+        // 待出堆元素存放在最后
+        last := (*h)[len(*h)-1]
+        *h = (*h)[:len(*h)-1]
+        return last
+    }
+
+    // Len sort.Interface 的方法
+    func (h *intHeap) Len() int {
+        return len(*h)
+    }
+
+    // Less sort.Interface 的方法
+    func (h *intHeap) Less(i, j int) bool {
+        // 如果实现小顶堆，则需要调整为小于号
+        return (*h)[i].(int) > (*h)[j].(int)
+    }
+
+    // Swap sort.Interface 的方法
+    func (h *intHeap) Swap(i, j int) {
+        (*h)[i], (*h)[j] = (*h)[j], (*h)[i]
+    }
+
+    // Top 获取堆顶元素
+    func (h *intHeap) Top() any {
+        return (*h)[0]
+    }
+
+    /* Driver Code */
+    func TestHeap(t *testing.T) {
+        /* 初始化堆 */
+        // 初始化大顶堆
+        maxHeap := &intHeap{}
+        heap.Init(maxHeap)
+        /* 元素入堆 */
+        // 调用 heap.Interface 的方法，来添加元素
+        heap.Push(maxHeap, 1)
+        heap.Push(maxHeap, 3)
+        heap.Push(maxHeap, 2)
+        heap.Push(maxHeap, 4)
+        heap.Push(maxHeap, 5)
+
+        /* 获取堆顶元素 */
+        top := maxHeap.Top()
+        fmt.Printf("堆顶元素为 %d\n", top)
+
+        /* 堆顶元素出堆 */
+        // 调用 heap.Interface 的方法，来移除元素
+        heap.Pop(maxHeap)
+        heap.Pop(maxHeap)
+        heap.Pop(maxHeap)
+        heap.Pop(maxHeap)
+        heap.Pop(maxHeap)
 
+        /* 获取堆大小 */
+        size := len(*maxHeap)
+        fmt.Printf("堆元素数量为 %d\n", size)
+
+        /* 判断堆是否为空 */
+        isEmpty := len(*maxHeap) == 0
+        fmt.Printf("堆是否为空 %t\n", isEmpty)
+    }
     ```
 
 === "JavaScript"
@@ -188,7 +261,33 @@ comments: true
 === "Go"
 
     ```go title="my_heap.go"
+    type maxHeap struct {
+        // 使用切片而非数组，这样无需考虑扩容问题
+        data []any
+    }
+
+    /* 构造函数，建立空堆 */
+    func newHeap() *maxHeap {
+        return &maxHeap{
+            data: make([]any, 0),
+        }
+    }
 
+    /* 获取左子结点索引 */
+    func (h *maxHeap) left(i int) int {
+        return 2*i + 1
+    }
+
+    /* 获取右子结点索引 */
+    func (h *maxHeap) right(i int) int {
+        return 2*i + 2
+    }
+
+    /* 获取父结点索引 */
+    func (h *maxHeap) parent(i int) int {
+        // 向下整除
+        return (i - 1) / 2
+    }
     ```
 
 === "JavaScript"
@@ -249,7 +348,10 @@ comments: true
 === "Go"
 
     ```go title="my_heap.go"
-
+    /* 访问堆顶元素 */
+    func (h *maxHeap) peek() any {
+        return h.data[0]
+    }
     ```
 
 === "JavaScript"
@@ -350,7 +452,29 @@ comments: true
 === "Go"
 
     ```go title="my_heap.go"
+    /* 元素入堆 */
+    func (h *maxHeap) push(val any) {
+        // 添加结点
+        h.data = append(h.data, val)
+        // 从底至顶堆化
+        h.siftUp(len(h.data) - 1)
+    }
 
+    /* 从结点 i 开始，从底至顶堆化 */
+    func (h *maxHeap) siftUp(i int) {
+        for true {
+            // 获取结点 i 的父结点
+            p := h.parent(i)
+            // 当“越过根结点”或“结点无需修复”时，结束堆化
+            if p < 0 || h.data[i].(int) <= h.data[p].(int) {
+                break
+            }
+            // 交换两结点
+            h.swap(i, p)
+            // 循环向上堆化
+            i = p
+        }
+    }
     ```
 
 === "JavaScript"
@@ -477,7 +601,45 @@ comments: true
 === "Go"
 
     ```go title="my_heap.go"
+    /* 元素出堆 */
+    func (h *maxHeap) poll() any {
+        // 判空处理
+        if h.isEmpty() {
+            fmt.Println("error")
+        }
+        // 交换根结点与最右叶结点（即交换首元素与尾元素）
+        h.swap(0, h.size()-1)
+        // 删除结点
+        val := h.data[len(h.data)-1]
+        h.data = h.data[:len(h.data)-1]
+        // 从顶至底堆化
+        h.siftDown(0)
+
+        // 返回堆顶元素
+        return val
+    }
 
+    /* 从结点 i 开始，从顶至底堆化 */
+    func (h *maxHeap) siftDown(i int) {
+        for true {
+            // 判断结点 i, l, r 中值最大的结点，记为 max
+            l, r, max := h.left(i), h.right(i), i
+            if l < h.size() && h.data[l].(int) > h.data[max].(int) {
+                max = l
+            }
+            if r < h.size() && h.data[r].(int) > h.data[max].(int) {
+                max = r
+            }
+            // 若结点 i 最大或索引 l, r 越界，则无需继续堆化，跳出
+            if max == i {
+                break
+            }
+            // 交换两结点
+            h.swap(i, max)
+            // 循环向下堆化
+            i = max
+        }
+    }
     ```
 
 === "JavaScript"
@@ -545,7 +707,16 @@ comments: true
 === "Go"
 
     ```go title="my_heap.go"
-
+    /* 构造函数，根据切片建堆 */
+    func newMaxHeap(nums []any) *maxHeap {
+        // 所有元素入堆
+        h := &maxHeap{data: nums}
+        for i := len(h.data) - 1; i >= 0; i-- {
+            // 堆化除叶结点以外的其他所有结点
+            h.siftDown(i)
+        }
+        return h
+    }
     ```
 
 === "JavaScript"