Skip to content

Commit b10a205

Browse files
authored
Merge pull request #3020 from eseiler/doc/changelog
[DOC] Update changelog
2 parents 8bf33bc + 37f8ce1 commit b10a205

File tree

2 files changed

+70
-15
lines changed

2 files changed

+70
-15
lines changed

CHANGELOG.md

Lines changed: 69 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,67 @@ If possible, provide tooling that performs the changes, e.g. a shell-script.
2828

2929
## New features
3030

31-
#### Build system
31+
#### Alphabet
32+
* `seqan3::cigar` can now be assigned from `std::string_view` ([\#2966](https://github.com/seqan/seqan3/pull/2966)).
33+
* Added `seqan3::views::char_strictly_to`. Behaves like `seqan3::views::char_to`, but throws on invalid
34+
input ([\#2898](https://github.com/seqan/seqan3/pull/2898)).
35+
36+
#### I/O
37+
* Added `seqan3::sequence_file_option::fasta_ignore_blanks_before_id` to ignore blanks before IDs when reading FASTA
38+
files. E.g., `> some_id` will only store `"some_id"` as ID
39+
([\#2770](https://github.com/seqan/seqan3/pull/2770)).
40+
41+
#### Search
42+
* Improved performance of `seqan3::counting_vector::operator+=` ([\#2930](https://github.com/seqan/seqan3/pull/2930)).
3243

33-
* We now use Doxygen version 1.9.3 to build our documentation ([\#2923](https://github.com/seqan/seqan3/pull/2923)).
44+
#### Utility
45+
* Added `seqan3::list_traits::repeat` ([\#2899](https://github.com/seqan/seqan3/pull/2899)).
3446

3547
## Notable Bug-fixes
3648

49+
#### Core
50+
* Added missing implementations for AVX512 ([\#2920](https://github.com/seqan/seqan3/pull/2920) and
51+
[\#2926](https://github.com/seqan/seqan3/pull/2926)).
52+
3753
#### IO
54+
* FASTA files containing IDs starting with `>`, e.g., `> >MyID`, are now parsed correctly
55+
([\#2869](https://github.com/seqan/seqan3/pull/2869)).
3856

39-
* Fixed an issue parsing FASTA files containing sequence IDs that start with `>`
40-
([\#2869](https://github.com/seqan/seqan3/pull/2869)).
57+
#### Search
58+
* Relaxed `kmer_hash_view::iterator` difference requirement ([\#2931](https://github.com/seqan/seqan3/pull/2931)).
59+
* Relaxed `seqan3::views::minimiser` requirements to be C++20-compatible
60+
([\#2845](https://github.com/seqan/seqan3/pull/2845)).
61+
* Relaxed `seqan3::views::kmer_hash` requirements to be C++20-compatible
62+
([\#2843](https://github.com/seqan/seqan3/pull/2843)).
4163

4264
#### Utility
4365

44-
* `seqan3::views::single_pass_input` cannot propagate the `std::ranges::output_range` property, because it cannot
45-
satisfy the following requirement ([\#2775](https://github.com/seqan/seqan3/pull/2775)):
46-
```cpp
47-
*it++ = value;
48-
// must be the same as
49-
*it = value; ++it;
50-
// but it actually would be the same as
51-
++it; *it = value;
52-
```
66+
* `seqan3::views::single_pass_input` cannot propagate the `std::ranges::output_range` property because it cannot
67+
satisfy the following requirement ([\#2775](https://github.com/seqan/seqan3/pull/2775)):
68+
```cpp
69+
*it++ = value;
70+
// must be the same as
71+
*it = value; ++it;
72+
// but it actually would be the same as
73+
++it; *it = value;
74+
```
75+
* Fixed signature of `seqan3::detail::store_sse4`. This might have affected some public API
76+
([\#2893](https://github.com/seqan/seqan3/pull/2893)).
77+
* Relaxed `seqan3::views::to_simd` requirements to be C++20-compatible
78+
([\#2849](https://github.com/seqan/seqan3/pull/2849)).
5379

5480
## API changes
81+
GCC 7, 8, and 9 have been removed. All headers in `seqan3/std/` except `charconv` and `new` have been deprecated, please
82+
use the equivalent `std` includes.
83+
The namespace `std::cpp20` has been deprecated, please use `std::`.
84+
85+
`seqan3::views::to` has been changed to `seqan3::ranges::to`. Since it is not a view anymore, it cannot be properly
86+
deprecated. Please keep this in mind if you encounter errors with `seqan3::views::to`.
87+
88+
#### Compiler
89+
* Dropped support for GCC 7 and 8 ([\#2891](https://github.com/seqan/seqan3/pull/2891)).
90+
* Dropped support for GCC 9 ([\#2952](https://github.com/seqan/seqan3/pull/2952)).
91+
* Removed C++17 support ([\#2915](https://github.com/seqan/seqan3/pull/2915)).
5592

5693
#### I/O
5794
* Changed the default of `output_options::fasta_blank_before_id` to `false`
@@ -66,6 +103,24 @@ If possible, provide tooling that performs the changes, e.g. a shell-script.
66103
* Replaced `seqan3::views::to` (implemented via range-v3) with `seqan3::ranges::to` (implemented in SeqAn3).
67104
`seqan3::ranges::to` provides a subset of C++23's `std::ranges::to` and will be replaced with the STL-equivalent
68105
in a future version ([\#2969](https://github.com/seqan/seqan3/pull/2969)).
106+
* Replaced the implementation of `seqan3::views::chunk`. It is now implemented in SeqAn3 and does not use
107+
the range-v3 implementation anymore. `seqan3::views::chunk` is similar to C++23's `std::views::chunk`
108+
and will be replaced with the STL-equivalent in a future version
109+
([\#2975](https://github.com/seqan/seqan3/pull/2975)).
110+
* Replaced the implementation of `seqan3::views::join_with`. It is now implemented in SeqAn3 and does not use
111+
the range-v3 implementation anymore. `seqan3::views::join_with` is equivalent to C++23's `std::views::join_with`
112+
and will be replaced with the STL-equivalent in a future version
113+
([\#2973](https://github.com/seqan/seqan3/pull/2973)).
114+
* Replaced the implementation of `seqan3::views::zip`. It is now implemented in SeqAn3 and does not use
115+
the range-v3 implementation anymore. `seqan3::views::zip` is equivalent to C++23's `std::views::zip`
116+
and will be replaced with the STL-equivalent in a future version
117+
([\#2971](https://github.com/seqan/seqan3/pull/2971)).
118+
119+
#### Dependencies
120+
* We now use Doxygen version 1.9.4 to build our documentation ([\#2979](https://github.com/seqan/seqan3/pull/2979)).
121+
* Removed range-v3 ([\#2998](https://github.com/seqan/seqan3/pull/2998)).
122+
* Updated cereal to 1.3.2 ([\#3012](https://github.com/seqan/seqan3/pull/3012)).
123+
* Updated sdsl-lite to 3.0.1 ([\#3012](https://github.com/seqan/seqan3/pull/3012)).
69124

70125
# 3.1.0
71126

@@ -843,7 +898,7 @@ Note that 3.1.0 will be the first API stable release and interfaces in this rele
843898

844899
#### Argument parser
845900

846-
* The `seqan3::value_list_validator` is not constructible from a std::initialiser_list any more
901+
* The `seqan3::value_list_validator` is not constructible from a std::initialiser_list anymore
847902
(e.g. `seqan3::value_list_validator{{1,2,3}}` does not work, use `seqan3::value_list_validator{1,2,3}` instead)
848903
([\#1298](https://github.com/seqan/seqan3/pull/1298)).
849904
* Changed class signature of input/output file validators:

include/seqan3/utility/views/chunk.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ namespace seqan3::views
830830
*
831831
* \hideinitializer
832832
*
833-
* \experimentalapi
833+
* \noapi{This is a implementation of the C++23 chunk_view. It will be replaced with std::views::chunk.}
834834
*/
835835
inline constexpr auto chunk = detail::chunk_fn{};
836836

0 commit comments

Comments
 (0)