📃 docs(readme): 增加说明文档

meng-plus · meng-plus · commit addd8bf15d43 · 2025-03-23T23:43:19.000+08:00
diff --git a/readme.md b/readme.md
@@ -1 +1,182 @@
-# 算法库
+## 算法库
+
+本算法库提供了多种常用的算法实现，涵盖了滤波、拟合、排序、搜索及数组操作等领域。这些算法经过精心设计和优化，旨在为开发者提供高效、可靠的解决方案。
+
+## 目录
+
+1. [滤波算法](#1-滤波算法)
+2. [多项式拟合算法](#2-多项式拟合算法)
+3. [排序算法](#3-排序算法)
+4. [搜索算法](#4-搜索算法)
+5. [数组操作](#5-数组操作)
+6. [单元测试](#6-单元测试)
+7. [使用说明](#使用说明)
+8. [贡献指南](#贡献指南)
+9. [许可证](#许可证)
+
+## 1. 滤波算法
+
+滤波算法用于对信号或数据进行平滑处理，去除噪声或异常值。
+
+### 1.1 均值滤波
+
+均值滤波通过计算窗口内数据的平均值来平滑数据，适用于去除随机噪声。
+
+### 1.2 中值滤波
+
+中值滤波通过选取窗口内数据的中值来平滑数据，特别适用于去除椒盐噪声。
+
+### 1.3 移动平均滤波
+
+移动平均滤波通过计算窗口内数据的移动平均值来平滑数据，适用于时间序列数据的平滑处理。
+
+## 2. 多项式拟合算法
+
+多项式拟合算法用于拟合数据点，找到一个多项式函数来近似表示数据。
+
+### 2.1 线性拟合
+
+线性拟合通过最小化误差平方和，找到一条最优直线来拟合数据点。
+
+### 2.2 二次拟合
+
+二次拟合通过找到一个二次多项式函数来拟合数据点，适用于具有抛物线趋势的数据。
+
+### 2.3 三次拟合
+
+三次拟合通过找到一个三次多项式函数来拟合数据点，适用于具有更复杂趋势的数据。
+
+## 3. 排序算法
+
+排序算法用于将数据按照某种顺序进行排列。
+
+### 3.1 冒泡排序
+
+冒泡排序通过不断比较相邻元素并交换位置，将数据按升序或降序排列。
+
+### 3.2 选择排序
+
+选择排序通过不断选择最小（或最大）元素并放置在已排序部分的末尾，实现排序。
+
+### 3.3 希尔排序
+
+希尔排序是基于插入排序的改进算法，通过分组排序来提高效率。
+
+### 3.4 归并排序
+
+归并排序采用分治法，将数据分成两半分别排序，然后合并结果。
+
+### 3.5 快速排序
+
+快速排序通过选择一个基准元素，将数据分为两部分并递归排序，实现高效排序。
+
+### 3.6 堆排序
+
+堆排序利用二叉堆的数据结构，通过不断调整堆来实现排序。
+
+### 3.7 计数排序
+
+计数排序通过统计每个元素的出现次数，计算其在排序后数组中的位置。
+
+### 3.8 基数排序
+
+基数排序通过按位排序，从最低位到最高位逐步排序，适用于非负整数的排序。
+
+## 4. 搜索算法
+
+搜索算法用于在数据集中查找特定元素或统计信息。
+
+### 4.1 线性查找
+
+线性查找通过逐个检查元素，直到找到目标元素或遍历完整个数据集。
+
+### 4.2 二分查找
+
+二分查找通过不断缩小搜索范围，适用于已排序数据集的快速查找。
+
+### 4.3 查找最大值
+
+查找最大值算法通过遍历数据集，找到最大的元素。
+
+### 4.4 查找最小值
+
+查找最小值算法通过遍历数据集，找到最小的元素。
+
+### 4.5 查找数据出现次数
+
+查找数据出现次数算法通过统计特定元素在数据集中出现的次数。
+
+## 5. 数组操作
+
+数组操作算法用于对数组进行各种常见的操作和处理。
+
+### 5.1 去除重复
+
+去除重复算法通过过滤数组中的重复元素，返回一个唯一元素的数组。
+
+### 5.2 反转数组
+
+反转数组算法通过交换数组的首尾元素，将数组倒置。
+
+### 5.3 查找中位数
+
+查找中位数算法通过排序数组并找到中间元素，返回数组的中位数。
+
+### 5.4 查找众数
+
+查找众数算法通过统计数组中出现次数最多的元素，返回数组的众数。
+
+### 5.5 数组切片
+
+数组切片算法通过提取数组的指定部分，返回一个新的子数组。
+
+### 5.6 数组填充
+
+数组填充算法通过将数组的指定部分填充为特定值，修改原数组。
+
+### 5.7 数组拷贝
+
+数组拷贝算法通过复制数组的所有元素，返回一个新的数组副本。
+
+### 5.8 数组求和
+
+数组求和算法通过累加数组中的所有元素，返回数组元素的总和。
+
+### 5.9 数组平均值
+
+数组平均值算法通过计算数组元素的总和并除以元素个数，返回数组元素的平均值。
+
+## 6. 单元测试
+
+为确保算法的正确性和可靠性，我们提供了单元测试。所有测试代码位于 `test` 文件夹下。通过以下步骤，您可以运行测试：
+
+1. 进入 `test` 文件夹。
+   ```bash
+   cd test
+   ```
+2. 运行 `make` 命令以编译并执行测试。
+   ```bash
+   make test
+   ```
+
+`Makefile` 文件包含了编译和运行测试的指令，确保您的开发环境已安装必要的编译工具和依赖库。
+
+## 使用说明
+
+在使用本算法库时，请确保您已正确安装所需的依赖库，并遵循各算法的使用说明。我们建议您在使用前阅读相关文档，以充分理解每个算法的原理和适用场景。
+
+## 贡献指南
+
+如果您希望为算法库贡献代码或提出改进建议，请通过提交Pull Request或Issue的方式与我们联系。我们欢迎任何有助于提升算法库质量和功能的贡献。
+
+## 许可证
+
+本算法库基于MIT许可证开源，您可以自由地使用、修改和分发本库的代码。
+
+---
+
+感谢您使用本算法库，祝您开发顺利！
+
+---
+
+通过以上更新，您的 `README.md` 文件将更加全面，涵盖了单元测试的部分，并提供了明确的测试步骤，方便其他开发者理解和使用您的代码库。
diff --git a/src/algorithm.h b/src/algorithm.h
@@ -6,4 +6,5 @@
 #include "algorithms/polyfit.h"
 #include "algorithms/sort.h"
 #include "algorithms/search.h"
+#include "algorithms/array_utils.h"
 #endif // ALGORITHM_MODULE_H
diff --git a/src/algorithms/array_utils.c b/src/algorithms/array_utils.c
@@ -0,0 +1,120 @@
+#include "array_utils.h"
+#include <string.h> // 用于 memcpy 和 memcmp
+#include <stdlib.h> // 用于 malloc 和 free
+
+// 去重实现
+size_t remove_duplicates(void *base, size_t num, size_t size, CompareFunc compare)
+{
+    if (num == 0) return 0;
+
+    char *array         = (char *)base;
+    size_t unique_index = 0;
+
+    for (size_t i = 1; i < num; i++)
+    {
+        if (compare(array + i * size, array + unique_index * size) != 0)
+        {
+            unique_index++;
+            memcpy(array + unique_index * size, array + i * size, size);
+        }
+    }
+
+    return unique_index + 1; // 返回去重后的元素个数
+}
+
+// 反转数组实现
+void reverse_array(void *base, size_t num, size_t size)
+{
+    char *array = (char *)base;
+    for (size_t i = 0; i < num / 2; i++)
+    {
+        void *temp = malloc(size);
+        memcpy(temp, array + i * size, size);
+        memcpy(array + i * size, array + (num - i - 1) * size, size);
+        memcpy(array + (num - i - 1) * size, temp, size);
+        free(temp);
+    }
+}
+
+// 查找中位数实现
+void *find_median(void *base, size_t num, size_t size, CompareFunc compare)
+{
+    if (num == 0) return NULL;
+
+    quickSort(base, num, size, compare); // 先排序
+    return (char *)base + (num / 2) * size;
+}
+
+// 查找众数实现
+void *find_mode(void *base, size_t num, size_t size, CompareFunc compare)
+{
+    if (num == 0) return NULL;
+
+    quickSort(base, num, size, compare); // 先排序
+
+    char *array          = (char *)base;
+    void *mode           = array;
+    size_t max_count     = 1;
+    size_t current_count = 1;
+
+    for (size_t i = 1; i < num; i++)
+    {
+        if (compare(array + i * size, array + (i - 1) * size) == 0)
+        {
+            current_count++;
+            if (current_count > max_count)
+            {
+                max_count = current_count;
+                mode      = array + i * size;
+            }
+        }
+        else { current_count = 1; }
+    }
+
+    return mode;
+}
+
+// 数组切片实现
+void array_slice(void *dest, const void *src, size_t start, size_t end, size_t size)
+{
+    const char *source = (const char *)src;
+    char *destination  = (char *)dest;
+
+    for (size_t i = start; i < end; i++) { memcpy(destination + (i - start) * size, source + i * size, size); }
+}
+
+// 数组填充实现
+void array_fill(void *base, size_t num, size_t size, const void *value)
+{
+    char *array = (char *)base;
+    for (size_t i = 0; i < num; i++) { memcpy(array + i * size, value, size); }
+}
+
+// 数组拷贝实现
+void array_copy(void *dest, const void *src, size_t num, size_t size)
+{
+    memcpy(dest, src, num * size);
+}
+
+// 数组求和实现（适用于数值类型）
+double array_sum(const void *base, size_t num, size_t size)
+{
+    const char *array = (const char *)base;
+    double sum        = 0.0;
+
+    for (size_t i = 0; i < num; i++)
+    {
+        if (size == sizeof(int)) { sum += *(int *)(array + i * size); }
+        else if (size == sizeof(double)) { sum += *(double *)(array + i * size); }
+        // 可以扩展支持更多类型
+    }
+
+    return sum;
+}
+
+// 数组平均值实现（适用于数值类型）
+double array_average(const void *base, size_t num, size_t size)
+{
+    if (num == 0) return 0.0;
+    return array_sum(base, num, size) / num;
+}
diff --git a/src/algorithms/array_utils.h b/src/algorithms/array_utils.h
@@ -0,0 +1,20 @@
+#ifndef ARRAY_UTILS_H
+#define ARRAY_UTILS_H
+
+#include <stddef.h>
+#include "sort.h"
+// 比较函数指针类型
+typedef int (*CompareFunc)(const void *, const void *);
+
+// 数组操作功能
+size_t remove_duplicates(void *base, size_t num, size_t size, CompareFunc compare);   // 去重
+void reverse_array(void *base, size_t num, size_t size);                              // 反转数组
+void *find_median(void *base, size_t num, size_t size, CompareFunc compare);          // 查找中位数
+void *find_mode(void *base, size_t num, size_t size, CompareFunc compare);            // 查找众数
+void array_slice(void *dest, const void *src, size_t start, size_t end, size_t size); // 数组切片
+void array_fill(void *base, size_t num, size_t size, const void *value);              // 数组填充
+void array_copy(void *dest, const void *src, size_t num, size_t size);                // 数组拷贝
+double array_sum(const void *base, size_t num, size_t size);                          // 数组求和（适用于数值类型）
+double array_average(const void *base, size_t num, size_t size);                      // 数组平均值（适用于数值类型）
+
+#endif                                                                                // ARRAY_UTILS_H
diff --git a/src/algorithms/search.c b/src/algorithms/search.c
diff --git a/src/algorithms/search.h b/src/algorithms/search.h
