Simple-Matrix：Rust中简单的泛型矩阵库

谁，什么 & 为什么？

• 谁？
  • 我是一个对编程（以及Rust已经几个月了）感兴趣的法国学生。
• 什么？
  • 这是一个Rust中无依赖项的简单矩阵库。
  • 它没有意图成为 最好/最快/功能最全面的。
  • 尽管如此，如果优化保持了API的简单性，它们将被包括在内。
• 为什么？
  • 为了在Rust中变得更好，并发现其众多方面的一些。
  • 为了创建一个简单且可靠的矩阵库。

免责声明

这个crate不应该被认为足够成熟，适合 专业使用，如果您处于这种情况，请考虑其他替代方案，如 cgmath 或 nalgebra。

如果您仍然感兴趣，请随意继续！

使用方法

在您的项目的 Cargo.toml 文件中链接它

# Example Cargo.toml

[dependencies]
simple-matrix = "0.1"

然后，您可以在您的项目中使用它

Rust 2015

// Specify the extern crate in your lib.rs or main.rs
extern crate simple_matrix;

// You can now use it
use simple_matrix::Matrix;

let mat: Matrix<i32> = Matrix::new();

Rust 2018

// No need to specify an extern crate
// You can use it directly
use simple_matrix::Matrix;

let mat: Matrix<i32> = Matrix::new();

示例：基本矩阵使用

// Create a matrix of default cells
let zero: Matrix<u32> = Matrix::new(3, 3);

// Create a 2x4 matrix from an iterator (fill it row by row)
let mat1: Matrix<u32> = Matrix::from_iter(2, 4, 0..);

// Clone a matrix
let mat2 = mat1.clone();


// Add by reference (do not consume them)
let mut add = &mat1 + &mat2;

// Subtract by value (consume them)
let mut sub = mat1 - mat2;

// OpAssign are also available
sub += &zero;
sub -= zero;


// Get cells
let val: &u32 = add.get(0, 3).unwrap();

// Set cells
add.set(0, 3, 0);

// Iterate through the matrix (row by row)
for val in add {
    print!("{} ", val);
}

示例：点积

let mat: Matrix<f64> = Matrix::from_iter(2, 4, 0..);

// Construct the transposed matrix
let mat_t = mat.transpose();

// Construct the dot product
let dot = mat * mat_t;

功能

• 功能是库的扩展，用户可以选择启用。
• 它们可以增加编译时间和库大小。

要包含功能，请将其添加到您的 Cargo.toml 文件中

# Example Cargo.toml with added feature (replace values with your own)

[dependencies]
simple-matrix = { version = "0.1", features = ["impl_from"] }

以下列出了当前可用的功能及其简要说明

impl_from

为基本数值类型实现 From 特性。

let m1: Matrix<i8> = Matrix::new(3, 5);
let m2: Matrix<i64> = m1.into();

测试

• 在项目的根目录中运行 cargo test
• 目前禁用文档测试（rustdoc似乎与版2018不兼容）

基准

• 在项目的根目录中运行 cargo bench
• 基准由 Criterion crate处理，有关更详细的用法，请参阅其文档。

这些基准不是用于与其他矩阵crate进行比较，而是用于跟踪速度提升/回归。比较基准留给读者练习。

想参与吗？

创建一个新问题或拉取请求，我会检查它们（尽快）。