Add ability to find canonical substitution of DNA #48
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
vgel
reviewed
Oct 20, 2023
src/canonical.rs
Outdated
|
|
||
| impl<I: ExactSizeIterator<Item = Nucleotide>> ExactSizeIterator for ForwardCanonical<I> {} | ||
|
|
||
| // Like an allocation-free variant of: |
There was a problem hiding this comment.
Could maybe use some illustrative example code here? Took me a moment to realize what this meant.
| @@ -338,6 +339,16 @@ impl<T: NucleotideLike> FromStr for DnaSequence<T> { | |||
| } | |||
| } | |||
|
|
|||
| impl DnaSequence<Nucleotide> { | |||
| /// Return canonical isomorphic DNA sequence. | |||
There was a problem hiding this comment.
Could also maybe use some example code here as well, again just to illustrate. I tend to prefer having the docs on the method over the iterator type, since the method is mostly what library users interact with.
| let canonical2 = canonical.canonical(); | ||
| canonical2 == canonical | ||
| } | ||
| } |
There was a problem hiding this comment.
Do we want to quickcheck LexicalMin as well? Could compare it to the allocation version with Vec as a sanity check.
vgel
approved these changes
Oct 24, 2023
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.
Intent
Computes canonical substitution of DNA to support combinatorial hashing.
Changes
DnaSequenceStrict::canonicalconvenience method.quickdna::canonical::{Canonical, ForwardCanonical}iterators.canonicalbenchmarks.