Document sparse parity-check matrix support#657
Open
vedika-saravanan wants to merge 1 commit into
Open
Conversation
Signed-off-by: vedika-saravanan <vsaravanan@nvidia.com>
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.
Description
Documents the sparse parity-check matrix support introduced across #550, #599, and #602.
This PR:
sparse_binary_matrixandsparse_binary_matrix_layoutto the C++ API reference, including CSC/CSR storage, canonicalization semantics, and index limits.generate_random_pcm_sparseto the C++ API reference.sparse_binary_matrix,decoder_init, andmake_pcm_decoder.make_pcm_decoderdispatches PCM and Stim DEM inputs.Related: #550, #599, #602.
Runtime / performance impact
N/A. Documentation-only change.
Self-review checklist
Before requesting review
Scope and size
N/A: documentation-only change.
(if so, an issue has been raised).
Tests
N/A: documentation-only change.
just when it is missing.
N/A: documentation-only change.
N/A: documentation-only change.
EXPECT_*/assertchecks areinsufficient for algorithmic correctness.
N/A: documentation-only change.
No significant impact expected.
Documentation
tracked.
Code style
snake_casevscamelCase) forthe area being modified.
Dependencies
OSRB tickets filed.