docs: contributors + complete Cholesky decomposition scaffolding#52
Merged
Merged
Conversation
Adds a CONTRIBUTORS.md crediting Amir Ab Khoshk (hardware validation lead), Sepand Haghighi (reviewed and merged the project's original 2021 integration prototype, later archived under archive/legacy_integral/ and used as the algorithmic basis for Phase 1's integrate module), and Erfan Esmaeili (Cholesky decomposition, #51). Linked from README.md.
Adds the pieces every other function in this library has, on top of the implementation and tests from #51 (Erfan Esmaeili): - docs/algorithms/linalg.md: math formulation, complexity row, when to/not to use (including the symmetry-not-checked caveat) - validation/c/val_runner.c: benchmark + correctness check, same textbook matrix as the unit tests - validation/results/linalg/cholesky_decompose.md: first validation pass (ARM64/Apple M4 Pro, ASan/UBSan clean, both precisions), flagged as needing the full platform sweep before it matches the rest of linalg - README.md and CHANGELOG.md updated to mention the function Verified before committing: clean build, 335/335 tests (329 base + 6 Cholesky), ASan/UBSan clean, strict -Wall -Wextra -Werror clean in both float32 and float64.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTORS.md, crediting Amir Ab Khoshk (hardware validation), Sepand Haghighi (reviewed/merged the project's original 2021 integration prototype, archived underarchive/legacy_integral/), and Erfan Esmaeili (Cholesky decomposition, feat(linalg): add zero-dependency cholesky decomposition and unit tests #51). Linked from README.md.numx_cholesky_decompose(feat(linalg): add zero-dependency cholesky decomposition and unit tests #51) so it matches every other function in the library: math writeup indocs/algorithms/linalg.md, a benchmark + correctness check invalidation/c/val_runner.c, a validation results page, and README/CHANGELOG mentions.On the validation
Only ARM64/Apple M4 Pro is covered so far (ASan/UBSan clean, both float32 and float64, strict
-Wall -Wextra -Werrorclean). Flagged clearly in the validation doc that the full platform sweep (Windows, Raspberry Pi, ESP32-S3, Linux x86-64) is still needed before this carries the same weight as the rest oflinalg. Recommend not promoting tomain/ cutting a release until that's done.Test plan