SeqAn3  3.0.3
The Modern C++ library for sequence analysis.
seqan3::bitcompressed_vector< alphabet_type > Struct Template Reference

#include <seqan3/alphabet/container/bitpacked_sequence.hpp>

+ Inheritance diagram for seqan3::bitcompressed_vector< alphabet_type >:

Additional Inherited Members

- Public Types inherited from seqan3::bitpacked_sequence< alphabet_type >
using value_type = alphabet_type
 Equals the alphabet_type. More...
 
using reference = reference_proxy_type
 A proxy type (models seqan3::writable_semialphabet) that enables assignment, think of it as value_type &. More...
 
using const_reference = alphabet_type
 Equals the alphabet_type / value_type. More...
 
using iterator = detail::random_access_iterator< bitpacked_sequence >
 The iterator type of this container (a random access iterator). More...
 
using const_iterator = detail::random_access_iterator< bitpacked_sequence const >
 The const_iterator type of this container (a random access iterator). More...
 
using difference_type = std::ranges::range_difference_t< data_type >
 A signed integer type (usually std::ptrdiff_t) More...
 
using size_type = std::ranges::range_size_t< data_type >
 An unsigned integer type (usually std::size_t) More...
 
- Public Member Functions inherited from seqan3::bitpacked_sequence< alphabet_type >
 bitpacked_sequence ()=default
 Defaulted.
 
constexpr bitpacked_sequence (bitpacked_sequence const &)=default
 Defaulted.
 
constexpr bitpacked_sequence (bitpacked_sequence &&)=default
 Defaulted.
 
constexpr bitpacked_sequenceoperator= (bitpacked_sequence const &)=default
 Defaulted.
 
constexpr bitpacked_sequenceoperator= (bitpacked_sequence &&)=default
 Defaulted.
 
 ~bitpacked_sequence ()=default
 Defaulted.
 
template<typename other_range_t >
 bitpacked_sequence (other_range_t &&range)
 Construct from a different range. More...
 
 bitpacked_sequence (size_type const count, value_type const value)
 Construct with count times value. More...
 
template<std::forward_iterator begin_iterator_type, typename end_iterator_type >
 bitpacked_sequence (begin_iterator_type begin_it, end_iterator_type end_it)
 Construct from pair of iterators. More...
 
 bitpacked_sequence (std::initializer_list< value_type > ilist)
 Construct from std::initializer_list. More...
 
bitpacked_sequenceoperator= (std::initializer_list< value_type > ilist)
 Assign from std::initializer_list. More...
 
template<std::ranges::input_range other_range_t>
void assign (other_range_t &&range)
 Assign from a different range. More...
 
void assign (size_type const count, value_type const value)
 Assign with count times value. More...
 
template<std::forward_iterator begin_iterator_type, typename end_iterator_type >
void assign (begin_iterator_type begin_it, end_iterator_type end_it)
 Assign from pair of iterators. More...
 
void assign (std::initializer_list< value_type > ilist)
 Assign from std::initializer_list. More...
 
iterator begin () noexcept
 Returns an iterator to the first element of the container. More...
 
const_iterator begin () const noexcept
 Returns an iterator to the first element of the container. More...
 
const_iterator cbegin () const noexcept
 Returns an iterator to the first element of the container. More...
 
iterator end () noexcept
 Returns an iterator to the element following the last element of the container. More...
 
const_iterator end () const noexcept
 Returns an iterator to the element following the last element of the container. More...
 
const_iterator cend () const noexcept
 Returns an iterator to the element following the last element of the container. More...
 
reference at (size_type const i)
 Return the i-th element. More...
 
const_reference at (size_type const i) const
 Return the i-th element. More...
 
reference operator[] (size_type const i) noexcept
 Return the i-th element. More...
 
const_reference operator[] (size_type const i) const noexcept
 Return the i-th element. More...
 
reference front () noexcept
 Return the first element. Calling front on an empty container is undefined. More...
 
const_reference front () const noexcept
 Return the first element. Calling front on an empty container is undefined. More...
 
reference back () noexcept
 Return the last element. More...
 
const_reference back () const noexcept
 Return the last element. More...
 
constexpr data_type & raw_data () noexcept
 Provides direct, unsafe access to underlying data structures. More...
 
constexpr data_type const & raw_data () const noexcept
 Provides direct, unsafe access to underlying data structures. More...
 
bool empty () const noexcept
 Checks whether the container is empty. More...
 
size_type size () const noexcept
 Returns the number of elements in the container, i.e. std::distance(begin(), end()). More...
 
size_type max_size () const noexcept
 Returns the maximum number of elements the container is able to hold due to system or library implementation limitations, i.e. std::distance(begin(), end()) for the largest container. More...
 
size_type capacity () const noexcept
 Returns the number of elements that the container has currently allocated space for. More...
 
void reserve (size_type const new_cap)
 Increase the capacity to a value that's greater or equal to new_cap. More...
 
void shrink_to_fit ()
 Requests the removal of unused capacity. More...
 
constexpr bool operator== (bitpacked_sequence const &rhs) const noexcept
 Checks whether *this is equal to rhs. More...
 
constexpr bool operator!= (bitpacked_sequence const &rhs) const noexcept
 Checks whether *this is not equal to rhs. More...
 
constexpr bool operator< (bitpacked_sequence const &rhs) const noexcept
 Checks whether *this is less than rhs. More...
 
constexpr bool operator> (bitpacked_sequence const &rhs) const noexcept
 Checks whether *this is greater than rhs. More...
 
constexpr bool operator<= (bitpacked_sequence const &rhs) const noexcept
 Checks whether *this is less than or equal to rhs. More...
 
constexpr bool operator>= (bitpacked_sequence const &rhs) const noexcept
 Checks whether *this is greater than or equal to rhs. More...
 
void clear () noexcept
 Removes all elements from the container. More...
 
iterator insert (const_iterator pos, value_type const value)
 Inserts value before position in the container. More...
 
iterator insert (const_iterator pos, size_type const count, value_type const value)
 Inserts count copies of value before position in the container. More...
 
template<std::forward_iterator begin_iterator_type, typename end_iterator_type >
iterator insert (const_iterator pos, begin_iterator_type begin_it, end_iterator_type end_it)
 Inserts elements from range [begin_it, end_it) before position in the container. More...
 
iterator insert (const_iterator pos, std::initializer_list< value_type > const &ilist)
 Inserts elements from initializer list before position in the container. More...
 
iterator erase (const_iterator begin_it, const_iterator end_it)
 Removes specified elements from the container. More...
 
iterator erase (const_iterator pos)
 Removes specified elements from the container. More...
 
void push_back (value_type const value)
 Appends the given element value to the end of the container. More...
 
void pop_back ()
 Removes the last element of the container. More...
 
void resize (size_type const count)
 Resizes the container to contain count elements. More...
 
void resize (size_type const count, value_type const value)
 Resizes the container to contain count elements. More...
 
constexpr void swap (bitpacked_sequence &rhs) noexcept
 Swap contents with another instance. More...
 
constexpr void swap (bitpacked_sequence &&rhs) noexcept
 Swap contents with another instance. More...
 

Detailed Description

template<writable_semialphabet alphabet_type>
struct seqan3::bitcompressed_vector< alphabet_type >

Deprecated:
Use seqan3::bitpacked_sequence instead.

The documentation for this struct was generated from the following file: