Skip to content

feat: add Rust CI workflow #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dwego merged 3 commits into from
Jul 11, 2026
Merged

feat: add Rust CI workflow #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c949b2a
feat: add Rust CI workflow
dwego Jul 11, 2026
c6c2536
feat: format Rust code
dwego Jul 11, 2026
4329574
fix: rename crate to snake case
dwego Jul 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/rust.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Rust

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
test:
name: Test
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Cache Cargo dependencies
uses: Swatinem/rust-cache@v2

- name: Check formatting
run: cargo fmt --all -- --check

- name: Run Clippy
run: cargo clippy --all-targets --all-features -- -D warnings

- name: Run tests
run: cargo test --all-features
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "NumRS"
name = "num_rs"
version = "0.1.0"
edition = "2024"

Expand Down
8 changes: 4 additions & 4 deletions src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ pub enum MatrixError {
InvalidDataLength {
rows: usize,
cols: usize,
data_len: usize
data_len: usize,
},

#[error("Invalid index")]
OutOfBounds {
rows: usize,
cols: usize,
data_len: usize
data_len: usize,
},

#[error("Shape mismatch")]
ShapeMismatch {
rows: usize,
cols: usize,
data_len: usize
data_len: usize,
},

#[error("Internal unknown error: {0}")]
Other(#[from] std::io::Error),
}
}
164 changes: 36 additions & 128 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ mod tests {

#[test]
fn creates_matrix_with_valid_data() {
let matrix = Matrix::new(2, 3, vec![
1.0, 2.0, 3.0,
4.0, 5.0, 6.0,
]).unwrap();
let matrix = Matrix::new(2, 3, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).unwrap();

assert_eq!(matrix.rows(), 2);
assert_eq!(matrix.cols(), 3);
Expand Down Expand Up @@ -58,36 +55,25 @@ mod tests {
fn creates_identity_matrix() {
let matrix = Matrix::identity(3);

let expected = Matrix::new(3, 3, vec![
1.0, 0.0, 0.0,
0.0, 1.0, 0.0,
0.0, 0.0, 1.0,
]).unwrap();
let expected =
Matrix::new(3, 3, vec![1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0]).unwrap();

assert_eq!(matrix, expected);
assert!(matrix.is_square());
}

#[test]
fn creates_matrix_from_function() {
let matrix = Matrix::from_fn(2, 3, |row, col| {
(row * 10 + col) as f64
});
let matrix = Matrix::from_fn(2, 3, |row, col| (row * 10 + col) as f64);

let expected = Matrix::new(2, 3, vec![
0.0, 1.0, 2.0,
10.0, 11.0, 12.0,
]).unwrap();
let expected = Matrix::new(2, 3, vec![0.0, 1.0, 2.0, 10.0, 11.0, 12.0]).unwrap();

assert_eq!(matrix, expected);
}

#[test]
fn gets_matrix_value() {
let matrix = Matrix::new(2, 3, vec![
1.0, 2.0, 3.0,
4.0, 5.0, 6.0,
]).unwrap();
let matrix = Matrix::new(2, 3, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).unwrap();

assert_eq!(matrix.get(0, 0).unwrap(), 1.0);
assert_eq!(matrix.get(0, 2).unwrap(), 3.0);
Expand Down Expand Up @@ -149,83 +135,50 @@ mod tests {

#[test]
fn adds_matrices() {
let a = Matrix::new(2, 2, vec![
1.0, 2.0,
3.0, 4.0,
]).unwrap();
let a = Matrix::new(2, 2, vec![1.0, 2.0, 3.0, 4.0]).unwrap();

let b = Matrix::new(2, 2, vec![
10.0, 20.0,
30.0, 40.0,
]).unwrap();
let b = Matrix::new(2, 2, vec![10.0, 20.0, 30.0, 40.0]).unwrap();

let result = a.add(&b).unwrap();

let expected = Matrix::new(2, 2, vec![
11.0, 22.0,
33.0, 44.0,
]).unwrap();
let expected = Matrix::new(2, 2, vec![11.0, 22.0, 33.0, 44.0]).unwrap();

assert_eq!(result, expected);
}

#[test]
fn subtracts_matrices() {
let a = Matrix::new(2, 2, vec![
10.0, 20.0,
30.0, 40.0,
]).unwrap();
let a = Matrix::new(2, 2, vec![10.0, 20.0, 30.0, 40.0]).unwrap();

let b = Matrix::new(2, 2, vec![
1.0, 2.0,
3.0, 4.0,
]).unwrap();
let b = Matrix::new(2, 2, vec![1.0, 2.0, 3.0, 4.0]).unwrap();

let result = a.sub(&b).unwrap();

let expected = Matrix::new(2, 2, vec![
9.0, 18.0,
27.0, 36.0,
]).unwrap();
let expected = Matrix::new(2, 2, vec![9.0, 18.0, 27.0, 36.0]).unwrap();

assert_eq!(result, expected);
}

#[test]
fn scales_matrix() {
let matrix = Matrix::new(2, 2, vec![
1.0, 2.0,
3.0, 4.0,
]).unwrap();
let matrix = Matrix::new(2, 2, vec![1.0, 2.0, 3.0, 4.0]).unwrap();

let result = matrix.scale(2.0);

let expected = Matrix::new(2, 2, vec![
2.0, 4.0,
6.0, 8.0,
]).unwrap();
let expected = Matrix::new(2, 2, vec![2.0, 4.0, 6.0, 8.0]).unwrap();

assert_eq!(result, expected);
}

#[test]
fn calculates_hadamard_product() {
let a = Matrix::new(2, 2, vec![
1.0, 2.0,
3.0, 4.0,
]).unwrap();
let a = Matrix::new(2, 2, vec![1.0, 2.0, 3.0, 4.0]).unwrap();

let b = Matrix::new(2, 2, vec![
10.0, 20.0,
30.0, 40.0,
]).unwrap();
let b = Matrix::new(2, 2, vec![10.0, 20.0, 30.0, 40.0]).unwrap();

let result = a.hadamard(&b).unwrap();

let expected = Matrix::new(2, 2, vec![
10.0, 40.0,
90.0, 160.0,
]).unwrap();
let expected = Matrix::new(2, 2, vec![10.0, 40.0, 90.0, 160.0]).unwrap();

assert_eq!(result, expected);
}
Expand All @@ -237,46 +190,32 @@ mod tests {

assert!(matches!(a.add(&b), Err(MatrixError::ShapeMismatch { .. })));
assert!(matches!(a.sub(&b), Err(MatrixError::ShapeMismatch { .. })));
assert!(matches!(a.hadamard(&b), Err(MatrixError::ShapeMismatch { .. })));
assert!(matches!(
a.hadamard(&b),
Err(MatrixError::ShapeMismatch { .. })
));
}

#[test]
fn transposes_matrix() {
let matrix = Matrix::new(2, 3, vec![
1.0, 2.0, 3.0,
4.0, 5.0, 6.0,
]).unwrap();
let matrix = Matrix::new(2, 3, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).unwrap();

let result = matrix.transpose();

let expected = Matrix::new(3, 2, vec![
1.0, 4.0,
2.0, 5.0,
3.0, 6.0,
]).unwrap();
let expected = Matrix::new(3, 2, vec![1.0, 4.0, 2.0, 5.0, 3.0, 6.0]).unwrap();

assert_eq!(result, expected);
}

#[test]
fn multiplies_matrices() {
let a = Matrix::new(2, 3, vec![
1.0, 2.0, 3.0,
4.0, 5.0, 6.0,
]).unwrap();
let a = Matrix::new(2, 3, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).unwrap();

let b = Matrix::new(3, 2, vec![
7.0, 8.0,
9.0, 10.0,
11.0, 12.0,
]).unwrap();
let b = Matrix::new(3, 2, vec![7.0, 8.0, 9.0, 10.0, 11.0, 12.0]).unwrap();

let result = a.matmul(&b).unwrap();

let expected = Matrix::new(2, 2, vec![
58.0, 64.0,
139.0, 154.0,
]).unwrap();
let expected = Matrix::new(2, 2, vec![58.0, 64.0, 139.0, 154.0]).unwrap();

assert_eq!(result, expected);
}
Expand All @@ -293,17 +232,9 @@ mod tests {

#[test]
fn compares_matrices_with_approximate_equality() {
let a = Matrix::new(1, 3, vec![
0.1 + 0.2,
1.00000000001,
3.0,
]).unwrap();

let b = Matrix::new(1, 3, vec![
0.3,
1.0,
3.0,
]).unwrap();
let a = Matrix::new(1, 3, vec![0.1 + 0.2, 1.00000000001, 3.0]).unwrap();

let b = Matrix::new(1, 3, vec![0.3, 1.0, 3.0]).unwrap();

assert!(a.approx_eq(&b, 1e-10));
}
Expand All @@ -327,27 +258,14 @@ mod tests {

#[test]
fn display_formats_matrix() {
let matrix = Matrix::new(
2,
2,
vec![1.0, 2.0, 3.0, 4.0],
)
.unwrap();

assert_eq!(
format!("{matrix}"),
"[1.0000, 2.0000]\n[3.0000, 4.0000]"
);
let matrix = Matrix::new(2, 2, vec![1.0, 2.0, 3.0, 4.0]).unwrap();

assert_eq!(format!("{matrix}"), "[1.0000, 2.0000]\n[3.0000, 4.0000]");
}

#[test]
fn index_reads_element() {
let matrix = Matrix::new(
2,
2,
vec![1.0, 2.0, 3.0, 4.0],
)
.unwrap();
let matrix = Matrix::new(2, 2, vec![1.0, 2.0, 3.0, 4.0]).unwrap();

assert_eq!(matrix[(1, 0)], 3.0);
}
Expand Down Expand Up @@ -375,12 +293,7 @@ mod tests {
let b = Matrix::ones(2, 2);

let result = (&a + &b).unwrap();
let expected = Matrix::new(
2,
2,
vec![2.0, 2.0, 2.0, 2.0],
)
.unwrap();
let expected = Matrix::new(2, 2, vec![2.0, 2.0, 2.0, 2.0]).unwrap();

assert_eq!(result, expected);
}
Expand All @@ -390,13 +303,8 @@ mod tests {
let matrix = Matrix::ones(2, 2);

let result = &matrix * 3.0;
let expected = Matrix::new(
2,
2,
vec![3.0, 3.0, 3.0, 3.0],
)
.unwrap();
let expected = Matrix::new(2, 2, vec![3.0, 3.0, 3.0, 3.0]).unwrap();

assert_eq!(result, expected);
}
}
}
Loading
Loading