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

Configures the alignment result to output the score. More...

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

+ Inheritance diagram for seqan3::align_cfg::output_score:

Public Member Functions

Constructor, destructor and assignment
constexpr output_score ()=default
 Defaulted.
 
constexpr output_score (output_score const &)=default
 Defaulted.
 
constexpr output_score (output_score &&)=default
 Defaulted.
 
constexpr output_scoreoperator= (output_score const &)=default
 Defaulted.
 
constexpr output_scoreoperator= (output_score &&)=default
 Defaulted.
 
 ~output_score ()=default
 Defaulted.
 

Static Private Attributes

static constexpr seqan3::detail::align_config_id id {seqan3::detail::align_config_id::output_score}
 Internal id to check for consistent configuration settings.
 

Detailed Description

Configures the alignment result to output the score.

This option forces the alignment to compute and output the score. If this option is not set in the alignment configuration, accessing the score via the seqan3::alignment_result object is forbidden and will lead to a compile time error.

Example

// 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 score.
}
Provides configuration for alignment output.
Configures the alignment result to output the score.
Definition align_config_output.hpp:40
Collection of elements to configure an algorithm.
Definition configuration.hpp:42
See also
seqan3::align_cfg::output_end_position
seqan3::align_cfg::output_begin_position
seqan3::align_cfg::output_alignment
seqan3::align_cfg::output_sequence1_id
seqan3::align_cfg::output_sequence2_id

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