seqan3::literals Namespace Reference

The SeqAn namespace for literals. More...

Functions
Other literals
constexpr cigar::operation	operator""_cigar_operation (char const c) noexcept
	The seqan3::cigar::operation char literal.
template<small_string< 2 > str>
constexpr uint16_t	operator""_tag ()
	The SAM tag literal, such that tags can be used in constant expressions.
constexpr shape	operator""_shape (unsigned long long const value)
	The seqan3::shape literal.
Nucleotide literals
Quality literals
constexpr phred42	operator""_phred42 (char const c) noexcept
	The seqan3::phred42 char literal.
constexpr phred63	operator""_phred63 (char const c) noexcept
	The seqan3::phred63 char literal.
constexpr phred68solexa	operator""_phred68solexa (char const c) noexcept
	The seqan3::phred68solexa char literal.
constexpr phred94	operator""_phred94 (char const c) noexcept
	The seqan3::phred94 char literal.
Structure literals

Detailed Description

The SeqAn namespace for literals.

This namespace can be imported to use SeqAn3's literal operators:

// 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
 
#include <seqan3/alphabet/nucleotide/dna4.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::dna4 letter = 'A'_dna4;             // identical to assign_char_to('A', letter);
    seqan3::dna4_vector sequence = "ACGT"_dna4; // identical to calling assign_char for each element
}

Function Documentation

operator""_cigar_operation()

constexpr cigar::operation seqan3::literals::operator""_cigar_operation ( char const  c )

constexprnoexcept

The seqan3::cigar::operation char literal.

Returns

seqan3::cigar::operation

You can use this char literal to assign a seqan3::cigar_operation character:

// 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
 
#include <seqan3/alphabet/cigar/cigar.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::cigar::operation letter1{'M'_cigar_operation};
    auto letter2 = 'M'_cigar_operation;
}

This entity is stable. Since version 3.1.

operator""_phred42()

constexpr phred42 seqan3::literals::operator""_phred42 ( char const  c )

constexprnoexcept

The seqan3::phred42 char literal.

Returns

seqan3::phred42

You can use this char literal to assign a seqan3::phred42 character:

// 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
 
#include <seqan3/alphabet/quality/phred42.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::phred42 letter1{'!'_phred42};
    auto letter2 = '!'_phred42;
}

This entity is stable. Since version 3.1.

operator""_phred63()

constexpr phred63 seqan3::literals::operator""_phred63 ( char const  c )

constexprnoexcept

The seqan3::phred63 char literal.

Returns

seqan3::phred63

You can use this char literal to assign a seqan3::phred63 character:

// 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
 
#include <seqan3/alphabet/quality/phred63.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::phred63 letter1{'!'_phred63};
    auto letter2 = '!'_phred63;
}

This entity is stable. Since version 3.1.

operator""_phred68solexa()

constexpr phred68solexa seqan3::literals::operator""_phred68solexa ( char const  c )

constexprnoexcept

The seqan3::phred68solexa char literal.

Returns

seqan3::phred68solexa

You can use this char literal to assign a seqan3::phred68solexa character:

// 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
 
#include <seqan3/alphabet/quality/phred68solexa.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::phred68solexa letter1{'!'_phred68solexa};
    auto letter2 = '!'_phred68solexa;
}

This entity is stable. Since version 3.1.

operator""_phred94()

constexpr phred94 seqan3::literals::operator""_phred94 ( char const  c )

constexprnoexcept

The seqan3::phred94 char literal.

Returns

seqan3::phred94

You can use this char literal to assign a seqan3::phred94 character:

// 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
 
#include <seqan3/alphabet/quality/phred94.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::phred94 letter1{'!'_phred94};
    auto letter2 = '!'_phred94;
}

This entity is stable. Since version 3.1.

operator""_shape()

constexpr shape seqan3::literals::operator""_shape ( unsigned long long const  value )

constexpr

The seqan3::shape literal.

Parameters

[in]

value

The unsigned integer to assign.

Returns

seqan3::shape