77template <std::ranges::viewable_range inner_type>
79 requires std::ranges::random_access_range<inner_type> && std::ranges::sized_range<inner_type> &&
80 (std::is_const_v<std::remove_reference_t<inner_type>> || std::ranges::view<inner_type>)
95 using ungapped_view_type =
decltype(
views::type_reduce(std::declval<inner_type &&>()));
124 using size_type = std::ranges::range_size_t<inner_type>;
160 template <
typename other_range_t>
162 requires (!std::same_as<other_range_t, gap_decorator>) &&
164 std::ranges::viewable_range<other_range_t>
186 return anchors.rbegin()->second + ungapped_view.size();
188 return ungapped_view.size();
212 assert(pos <=
size());
214 set_iterator_type it_set = anchors.upper_bound(anchor_gap_t{pos, bound_dummy});
216 if (it_set == anchors.begin())
218 anchors.emplace_hint(anchors.begin(), anchor_gap_t{pos, count});
223 auto gap_len{it_set->second};
224 if (it_set != anchors.begin())
225 gap_len -= (*(
std::prev(it_set))).second;
227 if (it_set->first + gap_len >= pos)
229 anchor_gap_t
gap{it_set->first, it_set->second +
count};
230 it_set = anchors.erase(it_set);
231 anchors.insert(it_set,
gap);
235 anchor_gap_t
gap{pos, it_set->second +
count};
237 anchors.insert(it_set,
gap);
263 throw gap_erase_failure(
"The range to be erased does not correspond to a consecutive gap.");
287 set_iterator_type it = anchors.upper_bound(anchor_gap_t{pos1, bound_dummy});
289 if (it == anchors.begin())
294 size_type const gap_len = gap_length(it);
297 if ((it->first + gap_len) < pos2)
299 throw gap_erase_failure{
"The range to be erased does not correspond to a consecutive gap."};
302 else if (gap_len == pos2 - pos1)
304 it = anchors.erase(it);
309 anchor_gap_t
gap{it->first, it->second - pos2 + pos1};
310 it = anchors.erase(it);
311 it = anchors.insert(it,
gap);
316 update(it, pos2 - pos1);
328 template <
typename unaligned_sequence_t>
330 requires std::assignable_from<gap_decorator &, unaligned_sequence_t>
414 throw std::out_of_range{
"Trying to access element behind the last in gap_decorator."};
422 throw std::out_of_range{
"Trying to access element behind the last in gap_decorator."};
470 lhs.anchors == rhs.anchors &&
471 std::ranges::equal(lhs.ungapped_view, rhs.ungapped_view))
485 return !(lhs == rhs);
494 auto lit = lhs.
begin();
495 auto rit = rhs.
begin();
497 while (lit != lhs.
end() && rit != rhs.
end() && *lit == *rit)
500 if (rit == rhs.
end())
502 else if (lit == lhs.
end())
514 auto lit = lhs.
begin();
515 auto rit = rhs.
begin();
517 while (lit != lhs.
end() && rit != rhs.
end() && *lit == *rit)
520 if (lit == lhs.
end())
522 else if (rit == rhs.
end())
534 return !(lhs <= rhs);
555 using set_iterator_type =
typename anchor_set_type::iterator;
572 size_type gap_length(set_iterator_type it)
const
574 return (it == anchors.begin()) ? it->second : it->second - (*
std::prev(it)).second;
589 void rupdate(size_type
const pos, size_type
const offset)
591 for (
auto it =
std::prev(anchors.end(), 1); it->first > pos;)
593 anchors.emplace_hint(it, anchor_gap_t{it->first +
offset, it->second +
offset});
594 anchors.erase(*it--);
610 void update(set_iterator_type it, size_type
const offset)
612 while (it != anchors.end())
614 anchor_gap_t gap{it->first -
offset, it->second -
offset};
615 it = anchors.erase(it);
616 it = anchors.insert(it, gap);
622 ungapped_view_type ungapped_view{};
625 anchor_set_type anchors{};
635template <std::ranges::viewable_range urng_t>
637 requires (!std::ranges::view<std::remove_reference_t<urng_t>>)
645template <std::ranges::view urng_t>
665template <std::ranges::viewable_range inner_type>
667 requires std::ranges::random_access_range<inner_type> && std::ranges::sized_range<inner_type> &&
668 (std::is_const_v<std::remove_reference_t<inner_type>> || std::ranges::view<inner_type>)
678 int64_t ungapped_view_pos{0};
684 typename gap_decorator::set_iterator_type anchor_set_it{};
686 bool is_at_gap{
true};
691 assert(new_pos <= host->
size());
694 anchor_set_it = host->anchors.upper_bound(anchor_gap_t{pos, host->bound_dummy});
695 ungapped_view_pos = pos;
697 if (anchor_set_it != host->anchors.begin())
699 typename gap_decorator::set_iterator_type prev{
std::prev(anchor_set_it)};
702 if (prev != host->anchors.begin())
705 ungapped_view_pos -= prev->second;
706 left_gap_end = prev->first + gap_len;
709 if (ungapped_view_pos !=
static_cast<int64_t
>(host->ungapped_view.size()) &&
710 pos >= left_gap_end && (anchor_set_it == host->anchors.end() || pos < anchor_set_it->first))
744 host(&host_), anchor_set_it{host_.anchors.begin()}
746 if (host_.anchors.
size() && (*host_.anchors.
begin()).first == 0)
749 left_gap_end = anchor_set_it->second;
774 if (pos < left_gap_end)
777 if (anchor_set_it == host->anchors.end() || pos < anchor_set_it->first)
780 if (ungapped_view_pos !=
static_cast<int64_t
>(host->ungapped_view.size()))
785 left_gap_end = anchor_set_it->first + anchor_set_it->second -
786 ((anchor_set_it != host->anchors.begin()) ? (
std::prev(anchor_set_it))->second : 0);
790 if (left_gap_end == host->size())
808 this->jump(this->pos + skip);
830 if (pos < left_gap_end)
832 (anchor_set_it != host->anchors.begin()) ? --anchor_set_it : anchor_set_it;
834 if (anchor_set_it != host->anchors.begin())
837 left_gap_end = prev->first + prev->second -
838 ((prev != host->anchors.begin()) ?
std::prev(prev)->second : 0);
846 else if (anchor_set_it == host->anchors.end() || pos < anchor_set_it->first)
867 this->jump(this->pos - skip);
914 return lhs.pos == rhs.pos;
920 return lhs.pos != rhs.pos;
926 return lhs.pos < rhs.pos;
932 return lhs.pos > rhs.pos;
938 return lhs.pos <= rhs.pos;
944 return lhs.pos >= rhs.pos;
The <algorithm> header from C++20's standard library.
Includes customized exception types for the alignment module .
Core alphabet concept and free function/type trait wrappers.
A combined alphabet that can hold values of either of its alternatives..
Definition: alphabet_variant.hpp:129
The iterator type over a seqan3::gap_decorator.
Definition: gap_decorator.hpp:671
gap_decorator_iterator & operator+=(difference_type const skip)
Advances iterator by skip many positions.
Definition: gap_decorator.hpp:806
friend bool operator<=(gap_decorator_iterator const &lhs, gap_decorator_iterator const &rhs) noexcept
Checks whether *this is less than or equal to rhs.
Definition: gap_decorator.hpp:936
reference operator*() const
Dereference operator returns a copy of the element currently pointed at.
Definition: gap_decorator.hpp:894
typename gap_decorator::difference_type difference_type
The difference type.
Definition: gap_decorator.hpp:721
friend gap_decorator_iterator operator+(difference_type const skip, gap_decorator_iterator const &it)
Returns an iterator copy advanced by skip many positions.
Definition: gap_decorator.hpp:819
gap_decorator_iterator operator--(int)
Returns a decremented iterator copy.
Definition: gap_decorator.hpp:857
gap_decorator_iterator operator+(difference_type const skip) const
Returns an iterator copy advanced by skip many positions.
Definition: gap_decorator.hpp:813
gap_decorator_iterator & operator=(gap_decorator_iterator const &)=default
Defaulted.
difference_type operator-(gap_decorator_iterator const lhs) const noexcept
Returns the distance between two iterators.
Definition: gap_decorator.hpp:884
gap_decorator_iterator operator++(int)
Returns an incremented iterator copy.
Definition: gap_decorator.hpp:798
gap_decorator_iterator & operator--()
Decrements iterator.
Definition: gap_decorator.hpp:825
gap_decorator_iterator & operator=(gap_decorator_iterator &&)=default
Defaulted.
typename gap_decorator::const_reference reference
The reference type.
Definition: gap_decorator.hpp:725
gap_decorator_iterator operator-(difference_type const skip) const
Returns an iterator copy advanced by skip many positions.
Definition: gap_decorator.hpp:872
friend bool operator<(gap_decorator_iterator const &lhs, gap_decorator_iterator const &rhs) noexcept
Checks whether *this is less than rhs.
Definition: gap_decorator.hpp:924
gap_decorator_iterator & operator++()
Increments iterator.
Definition: gap_decorator.hpp:769
gap_decorator_iterator(gap_decorator const &host_)
Construct from seqan3::gap_decorator and initialising to first position.
Definition: gap_decorator.hpp:743
gap_decorator_iterator(gap_decorator_iterator &&)=default
Defaulted.
friend gap_decorator_iterator operator-(difference_type const skip, gap_decorator_iterator const &it)
Returns an iterator copy advanced by skip many positions.
Definition: gap_decorator.hpp:878
friend bool operator!=(gap_decorator_iterator const &lhs, gap_decorator_iterator const &rhs) noexcept
Checks whether *this is not equal to rhs.
Definition: gap_decorator.hpp:918
gap_decorator_iterator(gap_decorator const &host_, typename gap_decorator::size_type const pos_)
Construct from seqan3::gap_decorator and explicit position.
Definition: gap_decorator.hpp:759
friend bool operator>=(gap_decorator_iterator const &lhs, gap_decorator_iterator const &rhs) noexcept
Checks whether *this is greater than or equal to rhs.
Definition: gap_decorator.hpp:942
friend bool operator>(gap_decorator_iterator const &lhs, gap_decorator_iterator const &rhs) noexcept
Checks whether *this is greater than rhs.
Definition: gap_decorator.hpp:930
gap_decorator_iterator(gap_decorator_iterator const &)=default
Defaulted.
~gap_decorator_iterator()=default
Defaulted.
friend bool operator==(gap_decorator_iterator const &lhs, gap_decorator_iterator const &rhs) noexcept
Checks whether *this is equal to rhs.
Definition: gap_decorator.hpp:912
value_type * pointer
The pointer type.
Definition: gap_decorator.hpp:727
gap_decorator_iterator & operator-=(difference_type const skip)
Advances iterator by skip many positions.
Definition: gap_decorator.hpp:865
typename gap_decorator::value_type value_type
The value type.
Definition: gap_decorator.hpp:723
void jump(typename gap_decorator::size_type const new_pos)
A helper function that performs the random access into the anchor set, updating all member variables.
Definition: gap_decorator.hpp:689
reference operator[](difference_type const n) const
Return underlying container value currently pointed at.
Definition: gap_decorator.hpp:900
gap_decorator_iterator()=default
Defaulted.
A gap decorator allows the annotation of sequences with gap symbols while leaving the underlying sequ...
Definition: gap_decorator.hpp:83
reference at(size_type const i)
Return the i-th element as a reference.
Definition: gap_decorator.hpp:411
friend bool operator==(gap_decorator const &lhs, gap_decorator const &rhs)
Checks whether lhs is equal to rhs.
Definition: gap_decorator.hpp:467
gap_decorator & operator=(gap_decorator const &)=default
Defaulted.
gap_decorator(gap_decorator &&rhs)=default
Defaulted.
const_reference at(size_type const i) const
Return the i-th element as a reference.
Definition: gap_decorator.hpp:419
std::ranges::range_difference_t< inner_type > difference_type
The difference type of the underlying sequence.
Definition: gap_decorator.hpp:130
const_iterator cend() const noexcept
Returns an iterator pointing behind the last element of the decorator.
Definition: gap_decorator.hpp:388
const_iterator end() const noexcept
Returns an iterator pointing behind the last element of the decorator.
Definition: gap_decorator.hpp:382
inner_type unaligned_sequence_type
The underlying ungapped range type.
Definition: gap_decorator.hpp:137
gap_decorator(other_range_t &&range)
Construct with the ungapped range type.
Definition: gap_decorator.hpp:166
reference operator[](size_type const i) const
Return the i-th element as a reference.
Definition: gap_decorator.hpp:438
friend bool operator!=(gap_decorator const &lhs, gap_decorator const &rhs)
Checks whether lhs is not equal to rhs.
Definition: gap_decorator.hpp:483
iterator erase_gap(const_iterator const it)
Erase one gap symbol at the indicated iterator postion.
Definition: gap_decorator.hpp:259
const_iterator begin() const noexcept
Returns an iterator to the first element of the container.
Definition: gap_decorator.hpp:356
iterator insert_gap(const_iterator const it, size_type const count=1)
Insert a gap of length count at the aligned sequence iterator position.
Definition: gap_decorator.hpp:206
~gap_decorator()=default
Defaulted.
iterator erase_gap(const_iterator const first, const_iterator const last)
Erase gap symbols at the iterator postions [first, last[.
Definition: gap_decorator.hpp:283
gap_decorator(gap_decorator const &)=default
Defaulted.
friend bool operator<=(gap_decorator const &lhs, gap_decorator const &rhs)
Checks whether lhs is less than or equal to rhs.
Definition: gap_decorator.hpp:512
size_type size() const
Returns the total length of the aligned sequence.
Definition: gap_decorator.hpp:183
reference const_reference
const_reference type equals reference type equals value type because the underlying sequence must not...
Definition: gap_decorator.hpp:118
gap_decorator & operator=(gap_decorator &&rhs)=default
Defaulted.
gapped< std::ranges::range_value_t< inner_type > > value_type
The variant type of the alphabet type and gap symbol type (see seqan3::gapped).
Definition: gap_decorator.hpp:105
friend bool operator>(gap_decorator const &lhs, gap_decorator const &rhs)
Checks whether lhs is greater than rhs.
Definition: gap_decorator.hpp:532
friend bool operator>=(gap_decorator const &lhs, gap_decorator const &rhs)
Checks whether lhs is greater than or equal to rhs.
Definition: gap_decorator.hpp:541
gap_decorator()=default
Default constructor.
friend bool operator<(gap_decorator const &lhs, gap_decorator const &rhs)
Checks whether lhs is less than rhs.
Definition: gap_decorator.hpp:492
std::ranges::range_size_t< inner_type > size_type
The size_type of the underlying sequence.
Definition: gap_decorator.hpp:124
friend void assign_unaligned(gap_decorator &dec, unaligned_sequence_t &&unaligned)
Assigns a new sequence of type seqan3::gap_decorator::unaligned_sequence_type to the decorator.
Definition: gap_decorator.hpp:332
const_iterator cbegin() const noexcept
Returns an iterator to the first element of the container.
Definition: gap_decorator.hpp:362
Thrown in function seqan3::erase_gap, if a position does not contain a gap.
Definition: exception.hpp:24
The alphabet of a gap character '-'.
Definition: gap.hpp:39
@ offset
Sequence (seqan3::field::seq) relative start position (0-based), unsigned value.
constexpr ptrdiff_t count
Count the occurrences of a type in a pack.
Definition: traits.hpp:169
constexpr size_t size
The size of a type pack.
Definition: traits.hpp:151
constexpr auto type_reduce
A view adaptor that behaves like std::views::all, but type erases certain ranges.
Definition: type_reduce.hpp:153
The main SeqAn3 namespace.
Definition: cigar_operation_table.hpp:2
gap_decorator(urng_t &&range) -> gap_decorator< std::remove_reference_t< urng_t > const & >
Ranges (not views!) always deduce to const & range_type since they are access-only anyway.
The <ranges> header from C++20's standard library.
Provides seqan3::views::type_reduce.