Fix shallow copy in getEntries and introduce new method
#104
Conversation
This file contains 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
Instead returning the object reference of the entries, now the method returns a new array (a deep copy of the entries) ensuring that any modifications to the returned array will never affect the original matrix data. In addition, the method documentation has been updated.
The method called `getReadOnlyEntries`, as the name implies, this method returns read-only (unmodifiable view) of the matrix entries offering a secure way to access the matrix elements without the risk of unintended modifications. Additionally, the documentation of this method has been added for API details and the implementation note.
github-actions
bot
added
bugfix
mitsuki31
added
feature
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.
Overview
This pull request addresses two key improvements to the matrix data access functionalities:
Fix shallow copy in
getEntries:The
getEntriesmethod originally returned a reference to the internal matrix data, potentially leading to unintended modifications. This change ensures a deep copy is returned, preserving data integrity.Introduce
getReadOnlyEntriesmethod:This new method provides a read-only view of the matrix entries, preventing accidental modifications and enhancing data security.
Changes Made
getEntriesMethodgetEntriesutilizesMatrixUtils.deepCopyOffor efficient and reliable copying.getReadOnlyEntriesMethodgetReadOnlyEntriesmethod that returns an unmodifiable view of the matrix elements. This method leveragesArrays.streamandCollections.unmodifiableListAPI to create the read-only structure.Note
Both methods have been thoroughly tested to ensure their correctness and stability.
Summary
This pull request improves data integrity and security by addressing the shallow copy issue (#103) and providing a read-only access method. It also enhances the API with clear documentation for both methods.