Vectorial 向量数学库技术文档

1. 安装指南

环境要求

• 支持C/C++编译器（如GCC、Clang等）。
• 支持SIMD指令集（如NEON、SSE等）。

安装步骤

1. 下载Vectorial库源码。
2. 将vectorial/include目录添加到你的项目包含路径中。
3. 在项目中包含相应的头文件以使用Vectorial库。

2. 项目使用说明

C语言使用

在C语言中，Vectorial库提供了纯C的SIMD包装器。你可以通过包含vectorial/simd4f.h头文件来使用这些功能。

#include "vectorial/simd4f.h"

simd4f v = simd4f_normalize( simd4f_add( simd4f_create(1,2,3,4), y) );
float z = simd4f_get_z(v);

C++使用

在C++中，Vectorial库提供了C++类来简化向量和矩阵的操作。你可以通过包含vectorial/vectorial.h头文件来使用这些类。

#include "vectorial/vectorial.h"

namespace myproject {
    using namespace ::vectorial;
    // 如果需要自定义名称，可以使用typedef
    // typedef vec3f Vector3;
}

using myproject::vec4f;

vec4f v = normalize( vec4f(1,2,3,4) + y );
float z = v.z();

3. 项目API使用文档

C语言API

• simd4f_create(float x, float y, float z, float w)：创建一个SIMD向量。
• simd4f_add(simd4f a, simd4f b)：向量加法。
• simd4f_normalize(simd4f v)：向量归一化。
• simd4f_get_z(simd4f v)：获取向量的Z分量。

C++ API

• vec4f(float x, float y, float z, float w)：创建一个4维向量。
• vec4f operator+(vec4f a, vec4f b)：向量加法。
• normalize(vec4f v)：向量归一化。
• float z()：获取向量的Z分量。

4. 项目安装方式

手动安装

1. 下载Vectorial库源码。
2. 将vectorial/include目录复制到你的项目目录中。
3. 在项目中添加包含路径：

   INCLUDES += -I$(PROJECT_DIR)/vectorial/include
   

使用CMake

如果你使用CMake构建系统，可以将其集成到你的项目中：

1. 将Vectorial库源码放入你的项目目录。
2. 在CMakeLists.txt中添加：

   include_directories(${PROJECT_SOURCE_DIR}/vectorial/include)
   

通过以上步骤，你可以在项目中成功使用Vectorial向量数学库。