Merge pull request #1 from felsenhower/master

Some performance and style improvements

Author: mblesel

.github/workflows/correctness_check.yaml

@@ -0,0 +1,48 @@
+name: Correctness Check
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build partdiff
+        run: cargo build --release
+
+      - name: Install Valgrind
+        run: sudo apt-get update && sudo apt-get install -y valgrind
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.9.8"
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Clone partdiff_tester
+        run: git clone https://github.com/parcio/partdiff_tester.git
+
+      - name: Run small correctness check subset with valgrind
+        run: |
+          cd partdiff_tester && \
+          uv run pytest -n auto --verbose \
+            --executable='../target/release/rust_partdiff' \
+            --strictness=4 \
+            --valgrind \
+            --shuffle=42 \
+            --max-num-tests=5
+
+      - name: Run correctness check
+        run: |
+          cd partdiff_tester && \
+          uv run pytest -n auto --verbose \
+            --executable='../target/release/rust_partdiff' \
+            --strictness=4 \
+            --shuffle=42

Cargo.toml

@@ -9,8 +9,5 @@ edition = "2018"
 [features]
 
 default = []
-2d-array-indexing = []
-C-style-indexing = []
-unsafe-indexing = []
 
 [dependencies]

README.md

@@ -1,14 +1,12 @@
 # rust_partdiff
+
 Program for calculation of partial differential equations implemented in Rust
 
-# building the crate
-To build the crate correctly currently some features have to be activated.
-## Features
-* Decide which indexing implementation is used for PartdiffMatrix
-  * feature: `2d-array-indexing` has a syntax of `matrix[[x,y]]` and should provide better performance
-  * feature: `C-style-indexing` has a syntax of `matrix[x][y]` and has probably worse performance due to the internals of the implementation 
-* Decide whether bounds checking should be used for matrix access
-  * feature: `unsafe-indexing` uses the unsafe `get_unchecked` methods of Vec and does no bounds checking but therefore performs better
-  * not building with `unsafe-indexing` defaults to using access methods of Vec that apply bounds checking
+## Usage
 
-The current default way to build the crate for performance should be: `cargo build --release --features "2d-array-indexing,unsafe-indexing"` 
+```shell
+$ git clone https://github.com/mblesel/rust_partdiff.git
+$ cd rust_partdiff
+$ cargo build --release
+$ target/release/rust_partdiff 1 2 100 1 2 100
+```