[INFRA] Move seqan3::search from search/algorithm/ to search/.
#1696
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
Irallia
requested review from
a team,
eseiler and
simonsasse
and removed request for
a team and
eseiler
Irallia
force-pushed
the
INFRA/search/move_search-algorithm_to_search
branch
from
9199be5
to
f06c1e9
Compare
Codecov Report
@@ Coverage Diff @@
## master #1696 +/- ##
==========================================
- Coverage 97.67% 97.65% -0.03%
==========================================
Files 237 237
Lines 9045 9050 +5
==========================================
+ Hits 8835 8838 +3
- Misses 210 212 +2
Continue to review full report at Codecov.
|
Irallia
force-pushed
the
INFRA/search/move_search-algorithm_to_search
branch
from
f06c1e9
to
69e368c
Compare
simonsasse
approved these changes
Mar 30, 2020
Irallia
force-pushed
the
INFRA/search/move_search-algorithm_to_search
branch
from
69e368c
to
9676fa7
Compare
rrahn
requested changes
Mar 30, 2020
include/seqan3/search/all.hpp
Outdated
| @@ -35,9 +35,56 @@ | |||
| * SeqAn currently supports very fast FM indices. For more details visit the \ref submodule_fm_index | |||
| * "FM Index submodule". | |||
| * | |||
| * ## Search Algorithms | |||
There was a problem hiding this comment.
Suggested change
| * ## Search Algorithms | |
| * ## Search algorithm |
include/seqan3/search/all.hpp
Outdated
| * The Search module offers a simple unified interface that allows searching FM indices and choosing the best | ||
| * algorithm based on the index at hand. | ||
| * | ||
| * ## FM Indices |
There was a problem hiding this comment.
Suggested change
| * ## FM Indices | |
| * ## FM indices |
include/seqan3/search/all.hpp
Outdated
| * | ||
| * A search scheme is a collection of searches, where each search `s` specifies the order in which the blocks are | ||
| * searched (`s.pi`), the lower error bounds (`s.l`) and the upper error bounds (`s.u`). If the number of blocks that | ||
| * the query sequences are split into are known at compile time, the data structure `search` is recommended, otherwise |
There was a problem hiding this comment.
Suggested change
| * the query sequences are split into are known at compile time, the data structure `search` is recommended, otherwise | |
| * the query sequences are split into are known at compile time, the data structure seqan3::detail::search is recommended, otherwise |
include/seqan3/search/all.hpp
Outdated
| * represented as `std::vector` of seqan3::detail::search_dyn. | ||
| * | ||
| * All optimum search schemes are disjoint, i.e. no error configuration is covered by more than one search. Thus there | ||
| * is no need for a filtration phase after searching to remove duplicate hits. Allowing insertions and deletions will |
There was a problem hiding this comment.
Suggested change
| * is no need for a filtration phase after searching to remove duplicate hits. Allowing insertions and deletions will | |
| * is no need for a filtration phase after searching to remove duplicate hits when searching with hamming distance. Allowing insertions and deletions will, however, |
include/seqan3/search/all.hpp
Outdated
| * the query sequences are split into are known at compile time, the data structure `search` is recommended, otherwise | ||
| * one has to use seqan3::detail::search_dyn. The first one implements its member variables as an an `std::array` of | ||
| * integers, the latter as an `std::vector` of integers. | ||
| * Similarily search schemes are defined. They are either implemented as an `std::array` of searches if the number of |
There was a problem hiding this comment.
Suggested change
| * Similarily search schemes are defined. They are either implemented as an `std::array` of searches if the number of | |
| * Search schemes are defined similiar. They are either implemented as an `std::array` of searches if the number of |
|
Also please add a API changelog entry. |
Signed-off-by: Lydia Buntrock <[email protected]>
rrahn
approved these changes
Apr 1, 2020
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.
Resolves #1695