Skip to content

Commit 68c7bd4

Browse files
smehringereseiler
andcommitted
[DOC] Cookbook and Changelog
Co-authored-by: Enrico Seiler <enrico.seiler@hotmail.de>
1 parent 507dba1 commit 68c7bd4

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ If possible, provide tooling that performs the changes, e.g. a shell-script.
3333
* Added `seqan3::views::char_strictly_to`. Behaves like `seqan3::views::char_to`, but throws on invalid
3434
input ([\#2898](https://github.com/seqan/seqan3/pull/2898)).
3535
* Improved performance of vector assignment for alphabets ([\#3038](https://github.com/seqan/seqan3/pull/3038)).
36+
* Improved performance of `seqan3::dna4::complement()` ([\#3026](https://github.com/seqan/seqan3/pull/3026)).
3637

3738
#### I/O
3839
* Added `seqan3::sequence_file_option::fasta_ignore_blanks_before_id` to ignore blanks before IDs when reading FASTA

doc/cookbook/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,14 @@ This will use `4` threads by default and can be adjusted by setting `seqan3::con
198198
the desired value:
199199

200200
\snippet doc/cookbook/compression_threads.cpp example
201+
202+
# Auto vectorized dna4 complement
203+
204+
Our alphabet seqan3::dna4 cannot be easily auto-vectorized by the compiler.
205+
206+
See [this discussion](https://github.com/seqan/seqan3/issues/1970) for more details.
207+
208+
You can add your own alphabet that is auto-vectorizable in some use cases.
209+
Here is an example for a dna4-like alphabet:
210+
211+
\snippet test/performance/simd_dna4.hpp cookbook

doc/cookbook/simd_dna4.cpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Checks that defining simd_dna4 works without putting it into the seqan3 namespace.
2+
3+
#define SEQAN3_USE_NAMESPACE 0
4+
#include <seqan3/test/performance/simd_dna4.hpp>
5+
6+
int main()
7+
{
8+
simd_dna4 [[maybe_unused]] letter{};
9+
}

0 commit comments

Comments
 (0)