vectrix

此crate提供了一种使用const泛型实现的堆分配、固定大小的Matrix<T, M, N>类型。

🚀 入门指南

将此crate添加到您的Cargo清单中。

cargo add vectrix

no_std也通过禁用默认的std功能得到支持。

cargo add vectrix --no-default-features --features=macro

🤸 使用方法

类型

基本的Matrix<T, M, N>类型表示一个有M行和N列的矩阵。此类型由数组数组支持。数据以列主序存储。还提供了一些方便的别名，用于常见的矩阵，如向量。

• Matrix<T, M, N> → 一个具有M行和N列的泛型矩阵类型。
• Vector<T, M> → 一个有M行的列向量。
• RowVector<T, N> → 一个有N列的行向量。

宏

提供宏以方便构建提供的类型。这些宏也可以在const上下文中使用。

• 可以使用matrix!宏构建任何大小的新的Matrix。

  let m = matrix![
      1, 3, 5;
      2, 4, 6;
  ];
  

  在上面的例子中，matrix 是一个 Matrix<_, 2, 3> 类型，有 2 行 3 列。

• 可以使用 vector! 和 row_vector! 宏分别构造列向量和行向量。

  let v = vector![1, 3, 3, 7];
  //  ^ type `Vector<_, 4>`
  assert_eq!(v, matrix![1; 3; 3; 7]);
  
  let v = row_vector![1, 3, 3, 7];
  //  ^^^^^^ type `RowVector<_, 4>`
  assert_eq!(v, matrix![1, 3, 3, 7]);
  

构造函数

以下列出了常用的构造函数。

• ::zero() → 构造一个新的矩阵，填充 T::zero()。
• ::identity() → 构造一个新的单位矩阵。
• ::repeat(..) → 构造一个新的矩阵，填充提供的值。
• ::repeat_with(..) → 构造一个新的矩阵，填充由提供的闭包计算出的值。
• ::from_iter(..) → 从迭代器构造一个新的矩阵。
• ::new(..) → 使用提供的组件构造一个新的向量。

访问元素

提供了三种元素访问方式。

• usize 索引以列主序选择矩阵中的第 n 个元素。

  let m = matrix![
      1, 2, 3;
      4, 5, 6;
  ];
  assert_eq!(m[1], 4);
  

• (usize, usize) 索引选择特定行和列位置的元素。

  let m = matrix![
      1, 2, 3;
      4, 5, 6;
  ];
  assert_eq!(m[(1, 0)], 4);
  

• 对于小型向量，可以使用传统名称的组件访问器。

  let mut v = vector![1, 2, 3, 4, 0, 0];
  v.y = 3;
  v.w = 7;
  assert_eq!(v.x, 1);
  assert_eq!(v.y, 3);
  assert_eq!(v.z, 3);
  assert_eq!(v.w, 7);
  assert_eq!(v.a, 0);
  assert_eq!(v.b, 0);
  

访问行或列

您可以使用 .row() 或 .column() 方法获取特定行或列的引用。您可以使用 _mut 变体获取可变引用。

let mut m = matrix![
    1, 2, 3;
    4, 7, 6;
];
let row = m.row_mut(1);
row[1] = 5;
assert_eq!(m.column(1), &[2, 5]);

let mut m = matrix![
    1, 3, 5;
    2, 3, 6;
];
m.as_mut_slice()[3] = 4;
assert_eq!(m.as_slice(), &[1, 2, 3, 4, 5, 6]);

let v = vector![1.1, 2.0];
let m = matrix![1, 2; 3, 4];
println!("vector: {:.2?}", v);
println!("matrix: {:?}", m);

vector: [1.10, 2.00]
matrix: [[1, 3], [2, 4]]

let cv = vector![1.1, 2.0];
let rv = row_vector![1.1, 2.0];
let m = matrix![1, 2; 3, 4];
println!("column vector: {:.2}", cv);
println!("row vector: {:.1}", rv);
println!("matrix: {:b}", m);

column vector:
 ┌      ┐
 │ 1.10 │
 │ 2.00 │
 └      ┘

row vector:
 ┌          ┐
 │ 1.1  2.0 │
 └          ┘

matrix:
 ┌         ┐
 │  1   10 │
 │ 11  100 │
 └         ┘

let m = matrix![
    1, -3;
    3, -7;
];
let exp = matrix![
    2, -6;
    6, -14;
];
assert_eq!(m * 2, exp);

let m = matrix![
    1, -3;
    3, -7;
];
let exp = matrix![
    2, -6;
    6, -14;
];
assert_eq!(m + m, exp);