Add some suggested edits for paper#5
Open
spencerpatty wants to merge 2 commits into
Open
Conversation
spencerpatty
commented
Jun 3, 2026
Comment on lines
+717
to
+723
| \begin{enumerate} | ||
| \item Changes to raw data wrapped in the \texttt{xyz\_wrapper} object class by users are immediately reflected in the \texttt{xyz\_wrapper} object class data and it is generally acceptable for data in an \texttt{xyz\_wrapper} to be modified by users at any time. An \texttt{xyz\_wrapper} may also be only partially initialized and then further initialized or completed over time, as would be the case when creating a new sparse matrix as a product of others. | ||
| \item A completed matrix in an \texttt{xyz\_wrapper} may additionally be wrapped with a \texttt{matrix\_opt} object to allow the library to create, store and use additional optimization data relevant to the matrix in sparse BLAS routines. Therefore, modifying underlying data in a \texttt{matrix\_opt} is more restricted than for an \texttt{xyz\_wrapper} only, as the library may have other optimized data stored which is based on the original user provided data and which would not automatically be updated. To effect any changes to the user-owned data in a \texttt{matrix\_opt} object, a library function, \texttt{spblas::update\_matrix}, must be invoked on the \texttt{matrix\_opt} object with the changes which allows to keep all data in the \texttt{matrix\_opt} synchronized and consistent. | ||
| \item Generally speaking, all sparse BLAS functionality will take \texttt{matrix\_opt} objects as the matrix input arguments and if a sparse BLAS routine creates a sparse matrix as an output, the output argument shall be an \texttt{xyz\_wrapper}, as it is created and filled over time through the distinct stages of the functionality. | ||
| \item A sparse BLAS function shall only modify user-owned data, in a \texttt{matrix\_opt} or an \texttt{xyz\_wrapper}, if it is explicitly detailed in the functionality description that it will do so, like to sort the matrix or update provided data for the matrix, or to fill in resulting matrix data from a copy or transpose or other operation creating a new matrix. | ||
| \item Libraries or users are allowed to modify the properties (sorted, symmetric pattern, etc) in an \texttt{xyz\_wrapper} at any time as said property is discovered to be true or known to be true based on a particular algorithm whether the \texttt{xyz\_wrapper} is on it's own or in a \texttt{matrix\_opt}. | ||
| \end{enumerate} |
Contributor
Author
There was a problem hiding this comment.
I would love it if people can read and provide feedback on this. It might be too much detail or not the right detail for our intent of the paper, but it would be nice to have this written out somewhere (maybe in documentation if not here?) .
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
1 participant
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.
Changes: