Improved stack! implementation, tests (#1375)

* Add macro for concatenating matrices

* Replace DimUnify with DimEq::representative

* Add some simple cat macro output generation tests

* Fix formatting in cat macro code

* Add random prefix to cat macro output

* Add simple quote_spanned for cat macro

* Use `generic_view_mut` in cat macro

* Fix clippy lints in cat macro

* Clean up documentation for cat macro

* Remove identity literal from cat macro

* Allow references in input to cat macro

* Rename cat macro to stack

* Add more stack macro tests

* Add comment to explain reason for prefix in stack! macro

* Refactor matrix!, stack! macros into separate modules

* Take all blocks by reference in stack! macro

* Make empty stack![] invocation well-defined

* Fix stack! macro incorrect reference to data

* More extensive tests for stack! macro

* Move nalgebra-macros tests to nalgebra tests

By testing matrix!, stack! macros etc. in nalgebra, we ensure that
these macros are used in the same way that users will be using them.

* Fix stack! code generation tests

* Add back nalgebra as dev-dependency of nalgebra-macros

* Fix accidental wrong matrix! macro references in docs

* Rewrite stack! documentation for clarity

* Formatting

* Skip formatting of macro, rustfmt messes it up

* Rewrite stack! impl for improved clarity, Span behavior

This improves error messages upon dimension mismatch, among other
things. I've also tried to make the implementation easier to understand,
adding some comments to help the reader understand the individual steps.

* Use SameNumberOfRows/Columns instead of DimEq in stack! macro

This gives more accurate compiler errors if matrix dimensions
are mismatched.

* Check that stack! panics at runtime for basic dimension mismatch

* Add suggested edge cases from initial PR to tests

* stack! impl: use fixed prefix everywhere

This ensures that the expected generated code in tests
is the actual generated code when used in the wild.

* nalgebra-macros: Remove clippy pedantic, fix clippy complaints

pedantic seems to be mostly intent on wasting the programmer's time

* Add stack! sanity tests for built-ins and Complex

* Fix formatting in test

* Improve readability of format_ident! calls in stack! impl

* fix trybuild tests

* chore: run tests with a specific rust version

* More trybuild fixes

---------

Co-authored-by: Birk Tjelmeland <[email protected]>
Co-authored-by: Sébastien Crozet <[email protected]>

.github/workflows/nalgebra-ci-build.yml

@@ -13,37 +13,37 @@ jobs:
   check-fmt:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Check formatting
-      run: cargo fmt -- --check
+      - uses: actions/checkout@v2
+      - name: Check formatting
+        run: cargo fmt -- --check
   clippy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Install clippy
-      run: rustup component add clippy
-    - name: Run clippy
-      run: cargo clippy
+      - uses: actions/checkout@v2
+      - name: Install clippy
+        run: rustup component add clippy
+      - name: Run clippy
+        run: cargo clippy
   build-nalgebra:
     runs-on: ubuntu-latest
-#    env:
-#      RUSTFLAGS: -D warnings
+    #    env:
+    #      RUSTFLAGS: -D warnings
     steps:
-    - uses: actions/checkout@v2
-    - name: Build --no-default-feature
-      run: cargo build --no-default-features;
-    - name: Build (default features)
-      run: cargo build;
-    - name: Build --features serde-serialize
-      run: cargo build --features serde-serialize
-    - name: Build nalgebra-lapack
-      run: cd nalgebra-lapack; cargo build;
-    - name: Build nalgebra-sparse --no-default-features
-      run: cd nalgebra-sparse; cargo build --no-default-features;
-    - name: Build nalgebra-sparse (default features)
-      run: cd nalgebra-sparse; cargo build;
-    - name: Build nalgebra-sparse --all-features
-      run: cd nalgebra-sparse; cargo build --all-features;
+      - uses: actions/checkout@v2
+      - name: Build --no-default-feature
+        run: cargo build --no-default-features;
+      - name: Build (default features)
+        run: cargo build;
+      - name: Build --features serde-serialize
+        run: cargo build --features serde-serialize
+      - name: Build nalgebra-lapack
+        run: cd nalgebra-lapack; cargo build;
+      - name: Build nalgebra-sparse --no-default-features
+        run: cd nalgebra-sparse; cargo build --no-default-features;
+      - name: Build nalgebra-sparse (default features)
+        run: cd nalgebra-sparse; cargo build;
+      - name: Build nalgebra-sparse --all-features
+        run: cd nalgebra-sparse; cargo build --all-features;
   # Run this on it’s own job because it alone takes a lot of time.
   # So it’s best to let it run in parallel to the other jobs.
   build-nalgebra-all-features:
@@ -54,9 +54,18 @@ jobs:
       - run: cargo build -p nalgebra-glm --all-features;
   test-nalgebra:
     runs-on: ubuntu-latest
-#    env:
-#      RUSTFLAGS: -D warnings
+    #    env:
+    #      RUSTFLAGS: -D warnings
     steps:
+      # Tests are run with a specific version of the compiler to avoid
+      # trybuild errors when a new compiler version is out. This can be
+      # bumped as needed after running the tests with TRYBUILD=overwrite
+      # to re-generate the error reference.
+      - name: Select rustc  version
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.79.0
+          override: true
       - uses: actions/checkout@v2
       - name: test
         run: cargo test --features arbitrary,rand,serde-serialize,sparse,debug,io,compare,libm,proptest-support,slow-tests,rkyv-safe-deser,rayon;
@@ -85,8 +94,8 @@ jobs:
         run: cargo test -p nalgebra-macros
   build-wasm:
     runs-on: ubuntu-latest
-#    env:
-#      RUSTFLAGS: -D warnings
+    #    env:
+    #      RUSTFLAGS: -D warnings
     steps:
       - uses: actions/checkout@v2
       - run: rustup target add wasm32-unknown-unknown
@@ -121,6 +130,6 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Generate documentation
-      run: cargo doc
+      - uses: actions/checkout@v2
+      - name: Generate documentation
+        run: cargo doc

Cargo.toml

@@ -33,7 +33,6 @@ libm = ["simba/libm"]
 libm-force = ["simba/libm_force"]
 macros = ["nalgebra-macros"]
 
-
 # Conversion
 convert-mint = ["mint"]
 convert-bytemuck = ["bytemuck"]
@@ -122,6 +121,11 @@ nalgebra = { path = ".", features = ["debug", "compare", "rand", "macros"] }
 matrixcompare = "0.3.0"
 itertools = "0.13"
 
+# For macro testing
+trybuild = "1.0.90"
+
+cool_asserts = "2.0.3"
+
 [workspace]
 members = ["nalgebra-lapack", "nalgebra-glm", "nalgebra-sparse", "nalgebra-macros"]
 resolver = "2"

nalgebra-macros/Cargo.toml

@@ -21,5 +21,4 @@ quote = "1.0"
 proc-macro2 = "1.0"
 
 [dev-dependencies]
-nalgebra = { version = "0.32.0", path = ".." }
-trybuild = "1.0.42"
+nalgebra = { version = "0.32.1", path = ".." }