CANN/ops-collections昇腾容器库

ops-collections

【免费下载链接】ops-collectionsops-collections是基于昇腾硬件的高性能容器模板库，提供运行在NPU上的static_map、dynamic_map、set等容器。利用最新的SIMT并发能力，支持对容器的批量插入、查找等操作，提升整个系统的能力。项目地址: https://gitcode.com/cann/ops-collections

一、什么是ops-collections

ops-collections介绍

ops-collections是基于昇腾硬件的高性能容器模板库，提供运行在NPU上的static_map、dynamic_map、set等容器。利用最新的SIMT并发能力，支持对容器的批量插入、查找等操作，提升整个系统的能力。

软件架构

核心特性：

• 支持多种容器在NPU上的高性能执行
• 该库仅有头文件组成，使用时仅需引用头文件
• 使用风格接近STL库

目录结构

ops-collections ├── docs //文档文件 ├── doxygen //Doxygen配置文件 ├── include //存放公共头文件 │ ├── detail //容器实现细节 │ │ ├── extent //extent具体实现 │ │ ├── hash_functions //哈希函数实现 │ │ ├── open_addressing //开放寻址法实现 │ │ ├── pair //pair具体实现 │ │ ├── probing_scheme //probing_scheme具体实现 │ │ ├── static_map //static_map具体实现 │ │ └── storages //存储相关实现 │ ├── utility //通用函数、工具 │ ├── bucket_storage.h //BucketStorage容器头文件 │ ├── counter_storage.h //CounterStorage容器头文件 │ ├── extent.h //Extent头文件 │ ├── hash_functions.h //哈希函数对外头文件 │ ├── macros.h //宏定义 │ ├── pair.h //Pair头文件 │ ├── probing_scheme.h //探测策略头文件 │ ├── static_map.h //StaticMap容器对外头文件 │ ├── static_map_ref.h //StaticMapRef设备端引用头文件 │ └── storage.h //Storage基类头文件 ├── scripts //脚本文件存放目录 │ └── build.sh //构建脚本 └── tests //测试代码 ├── common //通用测试工具 ├── performance//性能测试 │ └── static_map ├── static_map //StaticMap单元测试 └── utility //基础组件测试

二、环境构建

快速安装CANN软件

本节提供快速安装CANN软件的示例命令，更多安装步骤请参考详细安装指南。

安装前准备

离线安装时，请单击获取链接下载CANN软件包，并上传到安装环境任意路径。

安装CANN

请使用CANN9.0.0-beta.2及以上版本，其他版本暂不支持。

chmod +x Ascend-cann-toolkit_${VERSION}_linux-$(arch).run # 其中${VERSION}表示对应的CANN版本 ./Ascend-cann-toolkit_${VERSION}_linux-$(arch).run --install

安装后配置

配置环境变量脚本set_env.sh，当前安装路径以${HOME}/Ascend为例。

source ${HOME}/Ascend/ascend-toolkit/set_env.sh

CANN详细安装指南

开发者可访问昇腾文档-昇腾社区->CANN社区版->软件安装，查看CANN软件安装引导，根据机器环境、操作系统和业务场景选择后阅读详细安装步骤。

测试依赖

ops-collections 的功能测试依赖于Catch2测试框架。

Catch2 版本要求

• 最低版本：v3.5.4
• 推荐版本：v3.5.4 或更高版本

自动安装

构建脚本会自动下载并安装 Catch2 框架，无需手动安装。在首次运行功能测试时，脚本会自动从 GitHub 克隆 Catch2 v3.5.4 到本地3rdparty/Catch2目录。

手动安装（可选）

如果需要手动安装 Catch2，可以执行以下命令：

git clone --depth 1 --branch v3.5.4 https://github.com/catchorg/Catch2.git 3rdparty/Catch2

注意：功能测试和性能测试是可选的，如果不需要运行测试，则无需安装 Catch2 框架。ops-collections 的核心功能作为纯头文件库，不依赖任何第三方库。

三、快速上手

运行ops-collections示例

下载

git clone https://gitcode.com/cann/ops-collections.git

您可自行选择需要的分支。

编译

注意：ops-collections正式功能通过头文件提供，不提供so或bin等编译产物，因此无需编译。为了方便用户快速了解其使用方法，ops-collections提供了一些调用示例，这部分示例需要编译后才能运行。

编译加速库，设置加速库环境变量：

cd ops-collections bash scripts/build.sh -b

执行功能测试用例

运行所有功能测试用例：

bash scripts/build.sh -r

运行个别测试用例（<test-name>替换为具体测试名称）：

bash scripts/build.sh -r --test-name <test-name>

执行性能测试用例

构建性能测试：

bash scripts/build.sh -p

生成的性能测试执行文件在/build/performance文件夹下

运行所有性能测试：

bash scripts/build.sh -rp

四、API介绍

API概述

容器类

核心API

辅助组件

API文档

本项目使用Doxygen开源工具来自动生成API文档。Doxygen作为C++代码的文档生成工具，通过代码中特定格式的注释来生成HTML文档，该项目提取了Readme.md和include文件夹中的内容。

运行以下命令，在docs/html中生成html文件：

bash scripts/build.sh -doc

打开html文件夹中的index.html文件，即为文档主页。

常用Doxygen注释命令清单如下： | 命令 | 说明 | |-----------------------|-------------------| |@brief|函数或类的简短描述| |@param|描述函数参数 | |@return/@returns|描述函数返回值| |@tparam|描述模板参数| |@note|强调重要说明，如性能、使用注意| |@warning|警告用户潜在风险，如类型限制、内存访问| |@see/@sa|交叉引用其他函数或类|

五、项目集成

ops-collections是一个纯头文件库，无需编译即可使用。只需在项目中包含头文件：

#include "static_map.h"

详细使用方法请参考 API文档和使用示例。

六、文档导航

• API文档和使用示例- 详细的API接口说明、参数说明、使用示例
• 开发指导- 环境构建、开发指南、性能测试

七、参与贡献

• 提交问题- 报告bug、请求新功能、提出改进建议
• 贡献代码- 欢迎Fork项目并提交Pull Request

八、更多资源

CANN社区版文档

九、许可证

CANN Open Software License Agreement Version 2.0

【免费下载链接】ops-collectionsops-collections是基于昇腾硬件的高性能容器模板库，提供运行在NPU上的static_map、dynamic_map、set等容器。利用最新的SIMT并发能力，支持对容器的批量插入、查找等操作，提升整个系统的能力。项目地址: https://gitcode.com/cann/ops-collections