quick-algo 0.1.4

A fast and efficient algorithm library for LPMM

QuickAlgo

这是一个快速算法库，旨在为LPMM（Long-term and Persistent Memory）模块提供Graph数据结构和一些复杂算法的Cpp+Cython高效实现。

目录结构

─ quick_algo - 项目目录  
 ├─ src - 源码目录
 │ └─ quick_algo - 纯C/C++代码目录
 │   ├─ cpp - 纯C/C++代码目录
 │   │ │ ├─ di_graph.hpp - 有向图头文件
 │   │ │ └─ di_graph_impl.cpp - 有向图实现
 │   │ ├─ cpp - 纯C/C++代码目录
 │   │ │ ├─ pagerank.hpp - 有向图头文件
 │   │ │ └─ pagerank_impl.cpp - 有向图实现
 │   │ ├─ __init__.py - Python包初始化文件
 │   │ ├─ di_graph.pxd - Cython头文件
 │   │ ├─ di_graph.pyi - di_graph类型声明文件
 │   │ └─ di_graph.pyx - Cython实现
 │   │ ├─ pagerank.pxd - Cython头文件
 │   │ ├─ pagerank.pyi - pagerank类型声明文件
 │   │ └─ pagerank.pyx - Cython实现
 │   └─ __init__.py - Python包初始化文件
 ├─ tests - 测试代码目录
 ├─ build_lib.py - 构建脚本
 ├─ pyproject.toml - Python项目配置文件
 ├─ setup.py - buildtools安装脚本
 ├─ LICENSE.txt - 许可证
 └─ README.md - 本文档

构建脚本

请在项目目录下执行build_lib.py并添加相应的任务，这将自动化构建过程。

该脚本支持以下任务：

• --cleanup：清理构建目录和临时文件
• --cythonize：编译Cython代码（要求依赖cython）
• --force_cythonize: 强制重新编译Cython代码（要求依赖cython）
• --build_sdist：构建Python源码分发包（要求依赖setuptools）
• --build_wheel：构建Python wheel包（要求依赖setuptools和C/Cpp编译环境；若无预生成.cpp，需先执行--cythonize）
• --install：安装Python包（要求依赖setuptools, 要求C/Cpp编译环境）

安装

您可以直接使用pip install quick-algo进行安装：

pip install quick-algo

注：PyPI上的预编译wheel默认不开启SIMD优化（兼容优先）。若您希望启用SIMD，可使用源码编译安装。

当前PyPI wheel覆盖：

• macOS Intel（x86_64）
• macOS Apple Silicon（arm64）
• Linux（x86_64 / aarch64）
• Windows（x86_64）

您也可以在clone本仓库之后通过前述构建脚本于本地进行编译安装。

在编译安装之前，请确保您装有以下依赖：

• setuptools: Python包管理工具
• Cython: Cython编译器
• MSVC/GCC/Clang: C/Cpp编译环境

要使用脚本编译安装，请在项目目录下执行以下命令：

python build_lib.py --cleanup --cythonize --install

测试

本项目的测试代码位于tests目录下，使用pytest进行测试。

在测试之前，请确保您装有以下依赖：

• pytest：测试框架
• networkx: 图算法库
• numpy: 数值计算库(由networkx要求)
• scipy: 数值计算库(由networkx要求)

要运行测试，请在项目目录下执行以下命令：

pytest ./tests -s