Merge pull request #8 from naomijub/minor-improvements_and_CI

Small improvements improvements

Author: DoubleHyphen

.github/workflows/rust.yml

@@ -0,0 +1,53 @@
+name: Rust
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "*" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install alsa and udev
+      run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev
+    - name: Build
+      run: cargo build --all-features --release --verbose
+      
+  test:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+    - uses: actions/checkout@v2
+    - name: Create folder
+      run: mkdir -p assets/voxel_data/
+    - name: Install alsa and udev
+      run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev
+    - name: tests
+      run: cargo test
+  
+  fmt:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: FMT
+      run: cargo fmt -- --check
+
+  clippy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install alsa and udev
+      run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev
+    - name: install-clippy
+      run: rustup component add clippy
+    - name: clippy
+      run: cargo clippy --all-features -- -W clippy::all -W clippy::nursery --deny "warnings"

.gitignore

@@ -0,0 +1,2 @@
+/target
+/Cargo.lock

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lindel"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["froderick <[email protected]>"]
 edition = "2018"
 description = "A crate for Hilbert and Morton encoding and decoding; in a word, linearising and delinearising."
@@ -18,12 +18,13 @@ repository = "https://github.com/DoubleHyphen/lindel"
 all-features = true
 
 [dependencies]
-num = {version = "0.2"}
-num-traits = {version = "0.2"}
+num = "0.4"
+num-traits = "0.2"
 nalgebra = {version = "0.25", optional = true}
 
 [dev-dependencies]
 rand = "0.8"
+criterion = "0.4"
 
 [dependencies.morton-encoding]
 version = "^2"
@@ -33,3 +34,8 @@ default-features = false
 default = ["std"]
 std = []
 nalg = ["nalgebra"]
+
+
+[[bench]]
+name = "metrics"
+harness = false

benches/metrics.rs

@@ -0,0 +1,29 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use lindel::*;
+
+pub fn criterion_benchmark(c: &mut Criterion) {
+    c.bench_function("hilbert_decode", |b| {
+        b.iter(|| {
+            let _: [u32; 3] = hilbert_decode(34589430);
+        })
+    });
+    c.bench_function("hilbert_encode", |b| {
+        b.iter(|| {
+            let _: u128 = hilbert_encode([43u32, 12, 32]);
+        })
+    });
+
+    c.bench_function("morton_decode", |b| {
+        b.iter(|| {
+            let _: [u32; 3] = morton_decode(34589430);
+        })
+    });
+    c.bench_function("morton_encode", |b| {
+        b.iter(|| {
+            let _: u128 = morton_encode([43u32, 12, 32]);
+        })
+    });
+}
+
+criterion_group!(benches, criterion_benchmark);
+criterion_main!(benches);

src/compact_encoding.rs

@@ -2,24 +2,24 @@
 //! Chris Hamilton, and (in the near future) of Compact Z-indices by the crate maintainer.
 
 /// Right rotation of x by b bits out of n.
-fn rotate_right(x: usize, b: u32, n: u32) -> usize {
+const fn rotate_right(x: usize, b: u32, n: u32) -> usize {
     let l = x & ((1 << b) - 1);
     let r = x >> b;
     (l << (n - b)) | r
 }
 
 /// Left rotation of x by b bits out of n.
-fn rotate_left(x: usize, b: u32, n: u32) -> usize {
+const fn rotate_left(x: usize, b: u32, n: u32) -> usize {
     rotate_right(x, n - b, n)
 }
 
 /// Binary reflected Gray code.
-fn gray_code(i: usize) -> usize {
+const fn gray_code(i: usize) -> usize {
     i ^ (i >> 1)
 }
 
 /// e(i), the entry point for the ith sub-hypercube.
-fn entry_point(i: usize) -> usize {
+const fn entry_point(i: usize) -> usize {
     if i == 0 {
         0
     } else {
@@ -28,13 +28,13 @@ fn entry_point(i: usize) -> usize {
 }
 
 /// g(i), the inter sub-hypercube direction.
-fn inter_direction(i: usize) -> u32 {
+const fn inter_direction(i: usize) -> u32 {
     // g(i) counts the trailing set bits in i
     (!i).trailing_zeros()
 }
 
 /// d(i), the intra sub-hypercube direction.
-fn intra_direction(i: usize) -> u32 {
+const fn intra_direction(i: usize) -> u32 {
     if i & 1 != 0 {
         inter_direction(i)
     } else if i > 0 {
@@ -45,7 +45,7 @@ fn intra_direction(i: usize) -> u32 {
 }
 
 /// T transformation inverse
-fn t_inverse(dims: u32, e: usize, d: u32, a: usize) -> usize {
+const fn t_inverse(dims: u32, e: usize, d: u32, a: usize) -> usize {
     rotate_left(a, d, dims) ^ e
 }
 
@@ -136,12 +136,12 @@ pub fn from_compact_hilbert_index(index: usize, bits: &[u32], point: &mut [usize
 }
 
 /// T transformation
-fn t(dims: u32, e: usize, d: u32, b: usize) -> usize {
+const fn t(dims: u32, e: usize, d: u32, b: usize) -> usize {
     rotate_right(b ^ e, d, dims)
 }
 
 /// GrayCodeInverse
-fn gray_code_inverse(mut g: usize) -> usize {
+const fn gray_code_inverse(mut g: usize) -> usize {
     let mut i = 0;
 
     while g != 0 {
@@ -199,8 +199,6 @@ pub fn compact_hilbert_index(bits: &[u32], point: &[usize]) -> usize {
     h
 }
 
-
- 
 /*fn returns_closure (xs: &[u8]) -> impl Fn(u32) -> u32 {
     let sum: u32 = xs.iter().map(|&x| x as u32).sum();
     move |a| a*sum