SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
No Matches
seqan3::align_cfg::output_begin_position Class Reference

Configures the alignment result to output the begin positions. More...

#include <seqan3/alignment/configuration/align_config_output.hpp>

+ Inheritance diagram for seqan3::align_cfg::output_begin_position:

Public Member Functions

Constructor, destructor and assignment
constexpr output_begin_position ()=default
constexpr output_begin_position (output_begin_position const &)=default
constexpr output_begin_position (output_begin_position &&)=default
constexpr output_begin_positionoperator= (output_begin_position const &)=default
constexpr output_begin_positionoperator= (output_begin_position &&)=default
 ~output_begin_position ()=default

Detailed Description

Configures the alignment result to output the begin positions.

This option forces the alignment to compute and output the begin positions of the aligned sequences. The begin positions must not be identical to the begin position of the original source sequences. For example, the optimal local alignment might only represent a slice of the original sequences. The begin positions denote the begin of the alignment within the original sequences, i.e. the positions of the first aligned characters.

If this option is not set in the alignment configuration, accessing the begin positions via the seqan3::alignment_result object is forbidden and will lead to a compile time error.


// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
int main()
// Compute only the begin position of the aligned sequences.
Provides configuration for alignment output.
Configures the alignment result to output the begin positions.
Definition align_config_output.hpp:128
Collection of elements to configure an algorithm.
Definition configuration.hpp:42
See also

The documentation for this class was generated from the following file:
Hide me