NiuTensor 项目教程

1. 项目目录结构及介绍

NiuTensor 项目的目录结构如下：

NiuTensor/
├── data/
├── doc/
├── source/
├── .gitignore
├── CMakeLists.txt
├── LICENSE
└── README.md

目录介绍：

• data/：存放项目的数据文件，通常用于测试和示例程序。
• doc/：存放项目的文档文件，包括开发文档、API 文档等。
• source/：存放项目的源代码文件，包括核心算法和实现。
• .gitignore：Git 版本控制系统的忽略文件配置。
• CMakeLists.txt：CMake 构建系统的配置文件，用于项目的编译和构建。
• LICENSE：项目的开源许可证文件，本项目使用 Apache-2.0 许可证。
• README.md：项目的介绍文件，包含项目的基本信息、安装方法和使用说明。

2. 项目启动文件介绍

NiuTensor 项目的启动文件位于 source/ 目录下，通常是 Main.cpp 文件。该文件包含了项目的入口函数 main()，用于启动和运行项目。

启动文件示例：

// source/Main.cpp

#include "XTensor.h"
#include "CHeader.h"
#include "FHeader.h"

using namespace nts;

int main() {
    // 初始化张量
    XTensor tensor;
    
    // 执行张量运算
    // ...

    return 0;
}

启动文件功能：

• 初始化张量：通过 XTensor 类初始化张量对象。
• 执行张量运算：调用 CHeader.h 和 FHeader.h 中的函数进行张量运算。

3. 项目配置文件介绍

NiuTensor 项目的配置文件主要是 CMakeLists.txt，用于配置项目的编译和构建过程。

CMakeLists.txt 配置文件示例：

# CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(NiuTensor)

set(CMAKE_CXX_STANDARD 11)

# 添加源文件
add_executable(NiuTensor source/Main.cpp)

# 添加库文件
target_link_libraries(NiuTensor PRIVATE NiuTensor)

# 配置第三方库
option(USE_MKL "Enable MKL" OFF)
option(USE_OPENBLAS "Enable OpenBLAS" OFF)
option(USE_CUDA "Enable CUDA" OFF)

if(USE_MKL)
    find_package(MKL REQUIRED)
    target_link_libraries(NiuTensor PRIVATE MKL::MKL)
endif()

if(USE_OPENBLAS)
    find_package(OpenBLAS REQUIRED)
    target_link_libraries(NiuTensor PRIVATE OpenBLAS::OpenBLAS)
endif()

if(USE_CUDA)
    find_package(CUDA REQUIRED)
    target_link_libraries(NiuTensor PRIVATE CUDA::cuda)
endif()

配置文件功能：

• 设置编译器标准：使用 C++11 标准进行编译。
• 添加源文件：将 Main.cpp 文件添加到可执行文件中。
• 链接库文件：将 NiuTensor 库链接到可执行文件中。
• 配置第三方库：根据用户选择启用 MKL、OpenBLAS 或 CUDA 库。

通过以上配置，用户可以根据自己的需求选择不同的第三方库进行加速计算。