Vbq

.github/workflows/bench.yaml

@@ -22,4 +22,4 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
 
       - name: Rust Benchmark
-        run: cargo bench
+        run: cargo bench --features benchmark-internals

.github/workflows/release.yaml

@@ -49,12 +49,12 @@ jobs:
       - name: Test in development mode
         env:
           RUSTFLAGS: "-D warnings"
-        run: cargo test
+        run: cargo test --features benchmark-internals
 
       - name: Test in release mode
         env:
           RUSTFLAGS: "-D warnings"
-        run: cargo test --release
+        run: cargo test --release --features benchmark-internals
 
       - name: "Install cargo-msrv"
         uses: taiki-e/install-action@v2
@@ -115,7 +115,7 @@ jobs:
         env:
           RUSTFLAGS: "-Zrandomize-layout"
           MIRIFLAGS: "-Zmiri-symbolic-alignment-check -Zmiri-disable-isolation"
-        run: cargo +${{ steps.rust-version.outputs.rustc }} miri test --no-fail-fast
+        run: cargo +${{ steps.rust-version.outputs.rustc }} miri test --no-fail-fast --features benchmark-internals
 
   python-test:
     runs-on: ${{ matrix.os }}

.github/workflows/test.yaml

@@ -48,7 +48,7 @@ jobs:
       - name: Lint with clippy
         env:
           RUSTFLAGS: "-D warnings"
-        run: cargo clippy --all-targets --all-features
+        run: cargo clippy --all-features
 
       # The environment variable `RUSTFLAGS` doesn't actually seem to have any effect on rustdoc,
       # but we set it here to the same value as in all other cargo runs as changing it would
@@ -61,19 +61,19 @@ jobs:
       - name: Test in development mode
         env:
           RUSTFLAGS: "-D warnings"
-        run: cargo test
+        run: cargo test --features benchmark-internals
 
       - name: Test in release mode
         env:
           RUSTFLAGS: "-D warnings"
-        run: cargo test --release
+        run: cargo test --release --features benchmark-internals
 
       - name: "Install cargo-msrv"
         uses: taiki-e/install-action@v2
         if: matrix.os != 'windows-latest' # work around https://github.com/foresterre/cargo-msrv/issues/1036
         with:
           tool: cargo-msrv
-      
+
       - name: "Verify minimum supported rust version (MSRV)"
         if: matrix.os != 'windows-latest' # work around https://github.com/foresterre/cargo-msrv/issues/1036
         run: cargo msrv verify -- cargo check --all-features
@@ -140,7 +140,7 @@ jobs:
         env:
           RUSTFLAGS: "-Zrandomize-layout"
           MIRIFLAGS: "-Zmiri-symbolic-alignment-check -Zmiri-disable-isolation"
-        run: cargo +${{ steps.rust-version.outputs.rustc }} miri test --no-fail-fast
+        run: cargo +${{ steps.rust-version.outputs.rustc }} miri test --no-fail-fast --features benchmark-internals
 
   python-test:
     runs-on: ${{ matrix.os }}

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "cSpell.words": [
+        "accums",
         "gaussian",
         "laplace",
         "parameterizable",

.vscode/tasks.json

@@ -72,6 +72,21 @@
 				"clear": true
 			},
 		},
+		{
+			"type": "cargo",
+			"command": "test",
+			"args": [
+				"--doc"
+			],
+			"problemMatcher": [
+				"$rustc"
+			],
+			"group": "build",
+			"label": "rust: cargo test --doc",
+			"presentation": {
+				"clear": true
+			},
+		},
 		{
 			"type": "cargo",
 			"command": "bench",
@@ -91,7 +106,12 @@
 				"$rustc"
 			],
 			"group": "build",
-			"label": "cargo check with pybindings"
+			"label": "cargo check with pybindings",
+			"presentation": {
+				"focus": true,
+				"showReuseMessage": true,
+				"clear": true
+			},
 		},
 		{
 			"label": "Build Python module and start REPL",
@@ -124,6 +144,16 @@
 			"presentation": {
 				"clear": true
 			},
+		},
+		{
+			"label": "Test Python module (without rebuilding)",
+			"type": "shell",
+			"command": "poetry run pytest tests/python",
+			"group": "build",
+			"problemMatcher": [],
+			"presentation": {
+				"clear": true
+			},
 		}
 	]
 }

Cargo.toml

@@ -1,17 +1,17 @@
 [package]
-authors = ["Robert Bamler <[email protected]>"] 
-categories = ["compression", "science", "no-std"] 
-description = "Entropy coders for research and production (Rust and Python)." 
-documentation = "https://docs.rs/constriction/" 
-edition = "2018" 
-homepage = "https://bamler-lab.github.io/constriction/" 
-keywords = ["compression", "entropy-coding", "range-coding", "python", "machine-learning"] 
-license = "MIT OR Apache-2.0 OR BSL-1.0" 
-name = "constriction" 
-readme = "README-rust.md" 
-repository = "https://github.com/bamler-lab/constriction/" 
+authors = ["Robert Bamler <[email protected]>"]
+categories = ["compression", "science", "no-std"]
+description = "Entropy coders for research and production (Rust and Python)."
+documentation = "https://docs.rs/constriction/"
+edition = "2018"
+homepage = "https://bamler-lab.github.io/constriction/"
+keywords = ["compression", "entropy-coding", "range-coding", "python", "machine-learning"]
+license = "MIT OR Apache-2.0 OR BSL-1.0"
+name = "constriction"
+readme = "README-rust.md"
+repository = "https://github.com/bamler-lab/constriction/"
 rust-version = "1.75" # for feature `return_position_impl_trait_in_traits`
-version = "0.4.1" 
+version = "0.4.1"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -20,25 +20,27 @@ crate-type = ["rlib", "cdylib"]
 name = "constriction"
 
 [features]
+benchmark-internals = []
 default = ["std"]
 std = []
 
 # Use feature `pybindings` to compile the python extension module that provides
 # access to this library from python. This feature is turned off by default
 # because it causes problems with `cargo test` on Mac OS. To turn it on, run:
 #   cargo build --release --features pybindings
-pybindings = ["numpy", "pyo3"]
+pybindings = ["ndarray", "numpy", "pyo3", "rayon"]
 
 [dependencies]
 hashbrown = "0.15.0"
-num-traits = {version = "0.2.15", default-features = false, features = ["libm"]}
-smallvec = "1.6.1"
-
 libm = "0.2.6"
+num-traits = {version = "0.2.15", default-features = false, features = ["libm"]}
 probability = "0.20"
+smallvec = "1.6.1"
 
+ndarray = {version = "0.16.1", features = ["rayon"], optional = true}
 numpy = {version = "0.22", optional = true}
 pyo3 = {version = "0.22.5", features = ["extension-module"], optional = true}
+rayon = {version = "1.10.0", optional = true}
 
 [dev-dependencies]
 byteorder = "1.4.2"
@@ -49,5 +51,6 @@ rand_xoshiro = "0.6"
 
 [[bench]]
 harness = false
-name = "lookup"
+name = "bench"
+required-features = ["benchmark-internals"]
 test = true