From 1a55309b840b4d5e6387f26df4c8f01d8a326540 Mon Sep 17 00:00:00 2001 From: HeZongLun <13425468+hezonglun@user.noreply.gitee.com> Date: Sun, 24 Aug 2025 20:00:14 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=BA=86=20BloomFilter=20?= =?UTF-8?q?=E7=B1=BB=E3=80=81SortModule=20=E7=B1=BB=E7=9A=84=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../docs/NahidaProject-Generic/BloomFilter.md | 166 ++++++++++++++++++ .../docs/NahidaProject-Generic/SortModule.md | 84 +++++++++ .../NahidaProject-Generic/BloomFilter.md | 166 ++++++++++++++++++ .../NahidaProject-Generic/SortModule.md | 84 +++++++++ 4 files changed, 500 insertions(+) diff --git a/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/BloomFilter.md b/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/BloomFilter.md index e69de29..0c8e2b5 100644 --- a/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/BloomFilter.md +++ b/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/BloomFilter.md @@ -0,0 +1,166 @@ +# BloomFilter 类 + +提供 Bloom 过滤器的实现。 + +## 语法 + +``` cpp +class BloomFilter +``` + +## 成员 + +### 公共构造函数 + +无 + +### 公共方法 + +| 名称 | 描述 | +|---------------------------------------------------------------------------------------------------|-----------------------| +|void NahidaProject\::BloomFilter\::Set(const K& key) |添加一个元素 | +|bool NahidaProject\::BloomFilter\::Test(const K& key) const |测试一个元素是否在其中 | +|void NahidaProject\::BloomFilter\::Clear() |清除过滤器 | +|size_t NahidaProject\::BloomFilter\::GetUsedBits() const |获取使用大小 | +|double NahidaProject\::BloomFilter\::EstimateFalsePositiveRate(size_t element_count) const |假阳性比率 | +|size_t NahidaProject::BloomFilter\::EstimateElementCount() const |假阳性个数 | +|constexpr size_t NahidaProject\::BloomFilter\::Capacity() const noexcept |容量 | +|double NahidaProject\::BloomFilter\::LoadFactor() const |加载因子 | + + +## 注解 + + + +## 要求 + +`#include "BloomFilter.h"` + +## void NahidaProject\::BloomFilter\::Set(const K& key) + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|key |要添加的元素 | + +### 返回值 + +* 成功: true +* 失败: false + +### 备注 + +无 + +## bool NahidaProject\::BloomFilter\::Test(const K& key) const + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|key |要测试的元素 | + +### 返回值 + +* 成功: true +* 失败: false + +### 备注 + +无 + +## void NahidaProject\::BloomFilter\::Clear() + +### 参数 + +无 + +### 返回值 + +* 成功: 无 +* 失败: 无 + +### 备注 + +无 + +## size_t NahidaProject\::BloomFilter\::GetUsedBits() const + +### 参数 + +无 + +### 返回值 + +* 成功: 使用大小 +* 失败: 无 + +### 备注 + +无 + +## double NahidaProject\::BloomFilter\::EstimateFalsePositiveRate(size_t element_count) const + +### 参数 + +|名称 |描述 | +|--------------|--------------------| +|element_count |期望的假阳性个数 | + + +### 返回值 + +* 成功: 数值 +* 失败: 无 + +### 备注 + +无 + +## size_t NahidaProject\::BloomFilter\::EstimateElementCount() const + +### 参数 + +无 + +### 返回值 + +* 成功: 阳性个数 +* 失败: 无 + +### 备注 + +无 + +## constexpr size_t NahidaProject\::BloomFilter\::Capacity() const noexcept + +### 参数 + +无 + +### 返回值 + +* 成功: 容量大小 +* 失败: 无 + +### 备注 + +无 + +## double NahidaProject\::BloomFilter\::LoadFactor() const + +### 参数 + +无 + +### 返回值 + +* 成功: 因子 +* 失败: 无 + +### 备注 + +无 + + diff --git a/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/SortModule.md b/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/SortModule.md index e69de29..8061ce7 100644 --- a/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/SortModule.md +++ b/Documents/DocumentByDocusaurus/docs/NahidaProject-Generic/SortModule.md @@ -0,0 +1,84 @@ +# SortModule 类 + +提供多个排序算法。 + +## 语法 + +``` cpp +class SortModule +``` + +## 成员 + +### 公共构造函数 + +无 + +### 公共方法 + +| 名称 | 描述 | +|--------------------------------------------------------------------------------------|-------------| +| std\::vector\ NahidaProject\::SortModule\::BubbleSort(std\::vector\ vec) | 冒泡排序 | +| std\::vector\ NahidaProject\::SortModule\::SelectSort(std\::vector\ vec) | 选择排序 | +| std\::vector\ NahidaProject\::SortModule\::InsertSort(std\::vector\ vec) | 插入排序 | + +## 注解 + + + +## 要求 + +`#include "SortModule.h"` + +## std\::vector\ NahidaProject\::SortModule\::BubbleSort(std\::vector\ vec); + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|vec |要执行排序的 vector | + +### 返回值 + +* 成功: 排好序的 vector +* 失败: 无 + +### 备注 + +无 + +## std\::vector\ NahidaProject\::SortModule\::SelectSort(std\::vector\ vec); + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|vec |要执行排序的 vector | + +### 返回值 + +* 成功: 排好序的 vector +* 失败: 无 + +### 备注 + +无 + +## std\::vector\ NahidaProject\::SortModule\::InsertSort(std\::vector\ vec); + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|vec |要执行排序的 vector | + +### 返回值 + +* 成功: 排好序的 vector +* 失败: 无 + +### 备注 + +无 + + diff --git a/Documents/PureDocument/NahidaProject-Generic/BloomFilter.md b/Documents/PureDocument/NahidaProject-Generic/BloomFilter.md index e69de29..0c8e2b5 100644 --- a/Documents/PureDocument/NahidaProject-Generic/BloomFilter.md +++ b/Documents/PureDocument/NahidaProject-Generic/BloomFilter.md @@ -0,0 +1,166 @@ +# BloomFilter 类 + +提供 Bloom 过滤器的实现。 + +## 语法 + +``` cpp +class BloomFilter +``` + +## 成员 + +### 公共构造函数 + +无 + +### 公共方法 + +| 名称 | 描述 | +|---------------------------------------------------------------------------------------------------|-----------------------| +|void NahidaProject\::BloomFilter\::Set(const K& key) |添加一个元素 | +|bool NahidaProject\::BloomFilter\::Test(const K& key) const |测试一个元素是否在其中 | +|void NahidaProject\::BloomFilter\::Clear() |清除过滤器 | +|size_t NahidaProject\::BloomFilter\::GetUsedBits() const |获取使用大小 | +|double NahidaProject\::BloomFilter\::EstimateFalsePositiveRate(size_t element_count) const |假阳性比率 | +|size_t NahidaProject::BloomFilter\::EstimateElementCount() const |假阳性个数 | +|constexpr size_t NahidaProject\::BloomFilter\::Capacity() const noexcept |容量 | +|double NahidaProject\::BloomFilter\::LoadFactor() const |加载因子 | + + +## 注解 + + + +## 要求 + +`#include "BloomFilter.h"` + +## void NahidaProject\::BloomFilter\::Set(const K& key) + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|key |要添加的元素 | + +### 返回值 + +* 成功: true +* 失败: false + +### 备注 + +无 + +## bool NahidaProject\::BloomFilter\::Test(const K& key) const + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|key |要测试的元素 | + +### 返回值 + +* 成功: true +* 失败: false + +### 备注 + +无 + +## void NahidaProject\::BloomFilter\::Clear() + +### 参数 + +无 + +### 返回值 + +* 成功: 无 +* 失败: 无 + +### 备注 + +无 + +## size_t NahidaProject\::BloomFilter\::GetUsedBits() const + +### 参数 + +无 + +### 返回值 + +* 成功: 使用大小 +* 失败: 无 + +### 备注 + +无 + +## double NahidaProject\::BloomFilter\::EstimateFalsePositiveRate(size_t element_count) const + +### 参数 + +|名称 |描述 | +|--------------|--------------------| +|element_count |期望的假阳性个数 | + + +### 返回值 + +* 成功: 数值 +* 失败: 无 + +### 备注 + +无 + +## size_t NahidaProject\::BloomFilter\::EstimateElementCount() const + +### 参数 + +无 + +### 返回值 + +* 成功: 阳性个数 +* 失败: 无 + +### 备注 + +无 + +## constexpr size_t NahidaProject\::BloomFilter\::Capacity() const noexcept + +### 参数 + +无 + +### 返回值 + +* 成功: 容量大小 +* 失败: 无 + +### 备注 + +无 + +## double NahidaProject\::BloomFilter\::LoadFactor() const + +### 参数 + +无 + +### 返回值 + +* 成功: 因子 +* 失败: 无 + +### 备注 + +无 + + diff --git a/Documents/PureDocument/NahidaProject-Generic/SortModule.md b/Documents/PureDocument/NahidaProject-Generic/SortModule.md index e69de29..8061ce7 100644 --- a/Documents/PureDocument/NahidaProject-Generic/SortModule.md +++ b/Documents/PureDocument/NahidaProject-Generic/SortModule.md @@ -0,0 +1,84 @@ +# SortModule 类 + +提供多个排序算法。 + +## 语法 + +``` cpp +class SortModule +``` + +## 成员 + +### 公共构造函数 + +无 + +### 公共方法 + +| 名称 | 描述 | +|--------------------------------------------------------------------------------------|-------------| +| std\::vector\ NahidaProject\::SortModule\::BubbleSort(std\::vector\ vec) | 冒泡排序 | +| std\::vector\ NahidaProject\::SortModule\::SelectSort(std\::vector\ vec) | 选择排序 | +| std\::vector\ NahidaProject\::SortModule\::InsertSort(std\::vector\ vec) | 插入排序 | + +## 注解 + + + +## 要求 + +`#include "SortModule.h"` + +## std\::vector\ NahidaProject\::SortModule\::BubbleSort(std\::vector\ vec); + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|vec |要执行排序的 vector | + +### 返回值 + +* 成功: 排好序的 vector +* 失败: 无 + +### 备注 + +无 + +## std\::vector\ NahidaProject\::SortModule\::SelectSort(std\::vector\ vec); + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|vec |要执行排序的 vector | + +### 返回值 + +* 成功: 排好序的 vector +* 失败: 无 + +### 备注 + +无 + +## std\::vector\ NahidaProject\::SortModule\::InsertSort(std\::vector\ vec); + +### 参数 + +|名称 |描述 | +|--------|--------------------| +|vec |要执行排序的 vector | + +### 返回值 + +* 成功: 排好序的 vector +* 失败: 无 + +### 备注 + +无 + + -- Gitee