Changed: Improves linting and validation workflows

Adds markdown linting with configuration and JSON validation to the
linting process. Also refactors linting targets in the justfile to
incorporate the new linting and validation steps. Updates cspell
configuration to include markdownlint. Improves matrix tests.
Updates WARP.md file.

Author: acgetchell

.markdownlint.json

@@ -0,0 +1,11 @@
+{
+  "MD013": {"line_length": 160},
+  "MD018": false,
+  "MD024": false,
+  "MD029": false,
+  "MD033": false,
+  "MD038": false,
+  "MD041": false,
+  "MD060": false,
+  "_comment": "MD029 disabled - we prefer manual numbering over lazy numbering (1. 1. 1.) for better readability; MD060 disabled to avoid auto-reformatting tables"
+}

README.md

@@ -6,6 +6,7 @@
 [![Docs.rs](https://docs.rs/la-stack/badge.svg)](https://docs.rs/la-stack)
 [![CI](https://github.com/acgetchell/la-stack/actions/workflows/ci.yml/badge.svg)](https://github.com/acgetchell/la-stack/actions/workflows/ci.yml)
 [![rust-clippy analyze](https://github.com/acgetchell/la-stack/actions/workflows/rust-clippy.yml/badge.svg)](https://github.com/acgetchell/la-stack/actions/workflows/rust-clippy.yml)
+[![codecov](https://codecov.io/gh/acgetchell/la-stack/graph/badge.svg?token=4eKXa5QjuZ)](https://codecov.io/gh/acgetchell/la-stack)
 [![Audit dependencies](https://github.com/acgetchell/la-stack/actions/workflows/audit.yml/badge.svg)](https://github.com/acgetchell/la-stack/actions/workflows/audit.yml)
 
 Fast, stack-allocated linear algebra for fixed dimensions in Rust.
@@ -31,7 +32,9 @@ This crate exists primarily to support the [`delaunay`](https://crates.io/crates
 
 ## 🔢 Scalar types
 
-Today, the core types are implemented for `f64`. The intent is to support `f32` and `f64` (and `f128` if/when Rust gains a stable primitive for it). Longer term, we may add optional arbitrary-precision support (e.g. via `rug`) depending on performance.
+Today, the core types are implemented for `f64`. The intent is to support `f32` and `f64`
+(and `f128` if/when Rust gains a stable primitive for it). Longer term, we may add optional
+arbitrary-precision support (e.g. via `rug`) depending on performance.
 
 ## 🚀 Quickstart
 

WARP.md

@@ -2,6 +2,14 @@
 
 This file provides guidance to WARP (warp.dev) when working with code in this repository.
 
+## Priorities
+
+When making changes in this repo, prioritize (in order):
+
+- Correctness
+- Speed
+- Coverage (but keep the code idiomatic Rust)
+
 ## Common commands
 
 - Build (debug): `cargo build` (or `just build`)
@@ -31,4 +39,4 @@ This file provides guidance to WARP (warp.dev) when working with code in this re
 
 ## Publishing note
 
-- If you publish this crate to crates.io, prefer updating documentation *before* publishing a new version (doc-only changes still require a version bump on crates.io).
+- If you publish this crate to crates.io, prefer updating documentation *before* publishing a new version (doc-only changes still require a version bump on crates.io).

cspell.json

@@ -15,6 +15,7 @@
     "Justfile",
     "justfile",
     "lu",
+    "markdownlint",
     "MSRV",
     "msvc",
     "mult",

justfile

@@ -115,9 +115,22 @@ lint: lint-code lint-docs lint-config
 
 lint-code: fmt-check clippy doc-check
 
-lint-config: action-lint
+lint-config: validate-json action-lint
 
-lint-docs: spell-check
+lint-docs: markdown-lint spell-check
+
+markdown-lint:
+    #!/usr/bin/env bash
+    set -euo pipefail
+    files=()
+    while IFS= read -r -d '' file; do
+        files+=("$file")
+    done < <(git ls-files -z '*.md')
+    if [ "${#files[@]}" -gt 0 ]; then
+        printf '%s\0' "${files[@]}" | xargs -0 -n100 npx markdownlint --config .markdownlint.json --fix
+    else
+        echo "No markdown files found to lint."
+    fi
 
 # Spell check (cspell)
 #
@@ -151,3 +164,17 @@ test-all: test test-integration
 
 test-integration:
     cargo test --tests --verbose
+
+# File validation
+validate-json:
+    #!/usr/bin/env bash
+    set -euo pipefail
+    files=()
+    while IFS= read -r -d '' file; do
+        files+=("$file")
+    done < <(git ls-files -z '*.json')
+    if [ "${#files[@]}" -gt 0 ]; then
+        printf '%s\0' "${files[@]}" | xargs -0 -n1 jq empty
+    else
+        echo "No JSON files found to validate."
+    fi

src/matrix.rs

@@ -58,9 +58,13 @@ impl<const D: usize> Matrix<D> {
     #[inline]
     pub fn identity() -> Self {
         let mut m = Self::zero();
-        for i in 0..D {
+
+        let mut i = 0;
+        while i < D {
             m.rows[i][i] = 1.0;
+            i += 1;
         }
+
         m
     }
 
@@ -122,16 +126,15 @@ impl<const D: usize> Matrix<D> {
     #[inline]
     #[must_use]
     pub fn inf_norm(&self) -> f64 {
-        let mut max_row_sum = 0.0;
-        for r in 0..D {
-            let mut row_sum = 0.0;
-            for c in 0..D {
-                row_sum += self.rows[r][c].abs();
-            }
+        let mut max_row_sum: f64 = 0.0;
+
+        for row in &self.rows {
+            let row_sum: f64 = row.iter().map(|&x| x.abs()).sum();
             if row_sum > max_row_sum {
                 max_row_sum = row_sum;
             }
         }
+
         max_row_sum
     }
 
@@ -222,4 +225,22 @@ mod tests {
         let det = Matrix::<3>::identity().det(DEFAULT_PIVOT_TOL).unwrap();
         assert_approx(det, 1.0, 1e-12);
     }
+
+    #[test]
+    fn identity_has_ones_on_diag_and_zeros_off_diag() {
+        let m = Matrix::<3>::identity();
+
+        for r in 0..3 {
+            for c in 0..3 {
+                let expected = if r == c { 1.0 } else { 0.0 };
+                assert_approx(m.get(r, c).unwrap(), expected, 0.0);
+            }
+        }
+    }
+
+    #[test]
+    fn default_is_zero() {
+        let m = Matrix::<3>::default();
+        assert_approx(m.inf_norm(), 0.0, 0.0);
+    }
 }