adding tests for dissimrs and build wf

Author: rvalavi

.github/workflows/CI.yml

@@ -1,181 +1,28 @@
-# This file is autogenerated by maturin v1.9.5
-# To update, run
-#
-#    maturin generate-ci github
-#
-name: CI
+name: Build-test
 
 on:
   push:
-    branches:
-      - main
-      - master
-    tags:
-      - '*'
+    branches: [main, master]
   pull_request:
-  workflow_dispatch:
-
-permissions:
-  contents: read
+    branches: [main, master]
 
 jobs:
-  linux:
-    runs-on: ${{ matrix.platform.runner }}
-    strategy:
-      matrix:
-        platform:
-          - runner: ubuntu-22.04
-            target: x86_64
-          - runner: ubuntu-22.04
-            target: x86
-          - runner: ubuntu-22.04
-            target: aarch64
-          - runner: ubuntu-22.04
-            target: armv7
-          - runner: ubuntu-22.04
-            target: s390x
-          - runner: ubuntu-22.04
-            target: ppc64le
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - name: Build wheels
-        uses: PyO3/maturin-action@v1
-        with:
-          target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
-          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
-          manylinux: auto
-      - name: Upload wheels
-        uses: actions/upload-artifact@v4
-        with:
-          name: wheels-linux-${{ matrix.platform.target }}
-          path: dist
-
-  musllinux:
-    runs-on: ${{ matrix.platform.runner }}
-    strategy:
-      matrix:
-        platform:
-          - runner: ubuntu-22.04
-            target: x86_64
-          - runner: ubuntu-22.04
-            target: x86
-          - runner: ubuntu-22.04
-            target: aarch64
-          - runner: ubuntu-22.04
-            target: armv7
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - name: Build wheels
-        uses: PyO3/maturin-action@v1
-        with:
-          target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
-          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
-          manylinux: musllinux_1_2
-      - name: Upload wheels
-        uses: actions/upload-artifact@v4
-        with:
-          name: wheels-musllinux-${{ matrix.platform.target }}
-          path: dist
-
-  windows:
-    runs-on: ${{ matrix.platform.runner }}
-    strategy:
-      matrix:
-        platform:
-          - runner: windows-latest
-            target: x64
-          - runner: windows-latest
-            target: x86
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-          architecture: ${{ matrix.platform.target }}
-      - name: Build wheels
-        uses: PyO3/maturin-action@v1
-        with:
-          target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
-          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
-      - name: Upload wheels
-        uses: actions/upload-artifact@v4
-        with:
-          name: wheels-windows-${{ matrix.platform.target }}
-          path: dist
-
-  macos:
-    runs-on: ${{ matrix.platform.runner }}
-    strategy:
-      matrix:
-        platform:
-          - runner: macos-13
-            target: x86_64
-          - runner: macos-14
-            target: aarch64
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - name: Build wheels
-        uses: PyO3/maturin-action@v1
-        with:
-          target: ${{ matrix.platform.target }}
-          args: --release --out dist --find-interpreter
-          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
-      - name: Upload wheels
-        uses: actions/upload-artifact@v4
-        with:
-          name: wheels-macos-${{ matrix.platform.target }}
-          path: dist
-
-  sdist:
+  test:
+    name: Run Rust tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Build sdist
-        uses: PyO3/maturin-action@v1
-        with:
-          command: sdist
-          args: --out dist
-      - name: Upload sdist
-        uses: actions/upload-artifact@v4
-        with:
-          name: wheels-sdist
-          path: dist
-
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
-    needs: [linux, musllinux, windows, macos, sdist]
-    permissions:
-      # Use to sign the release artifacts
-      id-token: write
-      # Used to upload release artifacts
-      contents: write
-      # Used to generate artifact attestation
-      attestations: write
-    steps:
-      - uses: actions/download-artifact@v4
-      - name: Generate artifact attestation
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-path: 'wheels-*/*'
-      - name: Publish to PyPI
-        if: ${{ startsWith(github.ref, 'refs/tags/') }}
-        uses: PyO3/maturin-action@v1
-        env:
-          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
-        with:
-          command: upload
-          args: --non-interactive --skip-existing wheels-*/*
+      
+      - name: Set up Rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+      
+      - name: Run tests
+        run: cargo test core --no-default-features
+      
+      - name: Check code formatting
+        run: cargo fmt -- --check
+        continue-on-error: true
+      
+      - name: Run clippy
+        run: cargo clippy -- -D warnings
+        continue-on-error: true

Cargo.lock

@@ -13,14 +13,21 @@ pyo3 = {version = "0.22", default-features = false, features = ["macros", "gil-r
 pyo3-built = "0.5"
 numpy = {version = "0.22", features = ["gil-refs"]}
 ndarray = "0.16"
-rayon = "1.10"  # or the latest version
+rayon = "1.11"
 num_cpus = "1.16"
 simsimd = "6.5.9"
 rand = "0.8"
 anyhow = "1.0.100"
 
+[dev-dependencies]
+approx = "0.5"
+
 [profile.release]
 strip = true
 lto = true
 codegen-units = 1
-opt-level = 3 
+opt-level = 3
+
+[features]
+extension-module = ["pyo3/extension-module"]
+default = ["extension-module"]

Cargo.toml

@@ -27,3 +27,16 @@ Finally, compile and install the library into your active Python environment:
 ```bash
 maturin develop --release
 ```
+
+## Unit testing
+
+Testing core module (without Python binding):
+
+```bash
+cargo test core
+```
+Testing main Rust fucntion (same as above, now):
+
+```bash
+cargo test dissimrs
+```

README.md

@@ -84,3 +84,76 @@ pub fn dissimrs(
     Ok(out)
 }
 
+
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use ndarray::Array2;
+    use approx::assert_relative_eq;
+
+    fn create_test_affine() -> Affine {
+        let aff = (1.0, 0.0, 0.0, 0.0, 1.0, 0.0);
+        aff.into()
+    }
+
+    #[test]
+    fn test_dissimrs_basic() {
+        let x = Array2::from_shape_vec((3, 2), vec![
+            1.0, 2.0,
+            1.5, 2.5,
+            10.0, 20.0
+        ]).unwrap();
+
+        let trans = create_test_affine();
+        let result = dissimrs(&x, &trans, false, 1.0, None, 0, 2, 42).unwrap();
+
+        assert_eq!(result.len(), 3);
+        assert!(result.iter().all(|&v| v.is_finite()));
+        assert!(result[2] > result[0]);
+        assert!(result[2] > result[1]);
+    }
+
+    #[test]
+    fn test_dissimrs_with_nan() {
+        let x = Array2::from_shape_vec((4, 2), vec![
+            1.0, 2.0,
+            f32::NAN, 2.0,
+            3.0, 4.0,
+            5.0, f32::NAN,
+        ]).unwrap();
+
+        let trans = create_test_affine();
+        let result = dissimrs(&x, &trans, false, 1.0, None, 0, 2, 42).unwrap();
+
+        assert!(result[0].is_finite());
+        assert!(result[1].is_nan());
+        assert!(result[2].is_finite());
+        assert!(result[3].is_nan());
+    }
+
+    #[test]
+    fn test_dissimrs_identical_cells() {
+        let x = Array2::from_shape_vec((3, 2), vec![
+            1.0, 2.0,
+            1.0, 2.0,
+            1.0, 2.0,
+        ]).unwrap();
+
+        let trans = create_test_affine();
+        let result = dissimrs(&x, &trans, false, 1.0, None, 0, 2, 42).unwrap();
+
+        for &val in &result {
+            assert_relative_eq!(val, 0.0, epsilon = 1e-10);
+        }
+    }
+
+    #[test]
+    fn test_dissimrs_invalid_bandwidth() {
+        let x = Array2::from_shape_vec((3, 2), vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).unwrap();
+        let trans = create_test_affine();
+
+        assert!(dissimrs(&x, &trans, false, 0.0, None, 0, 2, 42).is_err());
+        assert!(dissimrs(&x, &trans, false, -1.0, None, 0, 2, 42).is_err());
+    }
+}