seqan3::dssp9 Class Reference

The protein structure alphabet of the characters "HGIEBTSCX".. More...

#include <seqan3/alphabet/structure/dssp9.hpp>

Inheritance diagram for seqan3::dssp9:

Public Member Functions
Constructors, destructor and assignment
constexpr	dssp9 () noexcept=default
	Defaulted.
constexpr	dssp9 (dssp9 const &) noexcept=default
	Defaulted.
constexpr	dssp9 (dssp9 &&) noexcept=default
	Defaulted.
constexpr dssp9 &	operator= (dssp9 const &) noexcept=default
	Defaulted.
constexpr dssp9 &	operator= (dssp9 &&) noexcept=default
	Defaulted.
	~dssp9 () noexcept=default
	Defaulted.
Public Member Functions inherited from seqan3::alphabet_base< dssp9, 9 >
constexpr	alphabet_base () noexcept=default
	Defaulted.
constexpr	alphabet_base (alphabet_base const &) noexcept=default
	Defaulted.
constexpr	alphabet_base (alphabet_base &&) noexcept=default
	Defaulted.
constexpr alphabet_base &	operator= (alphabet_base const &) noexcept=default
	Defaulted.
constexpr alphabet_base &	operator= (alphabet_base &&) noexcept=default
	Defaulted.
	~alphabet_base () noexcept=default
	Defaulted.
constexpr char_type	to_char () const noexcept
	Return the letter as a character of char_type. More...
constexpr rank_type	to_rank () const noexcept
	Return the letter's numeric value (rank in the alphabet). More...
constexpr dssp9 &	assign_char (char_type const chr) noexcept
	Assign from a character, implicitly converts invalid characters. More...
constexpr dssp9 &	assign_rank (rank_type const c) noexcept
	Assign from a numeric value. More...

Related Functions
(Note that these are not member functions.)
Structure literals
constexpr dssp9	operator""_dssp9 (char const ch) noexcept
	The seqan3::dssp9 char literal. More...
std::vector< dssp9 >	operator""_dssp9 (const char *str, std::size_t len)
	The seqan3::dssp9 string literal. More...

Additional Inherited Members
Static Public Attributes inherited from seqan3::alphabet_base< dssp9, 9 >
static constexpr detail::min_viable_uint_t< size >	alphabet_size
	The size of the alphabet, i.e. the number of different values it can take. More...
Protected Types inherited from seqan3::alphabet_base< dssp9, 9 >
using	char_type = std::conditional_t< std::same_as< char, void >, char, char >
	The char representation; conditional needed to make semi alphabet definitions legal. More...
using	rank_type = detail::min_viable_uint_t< size - 1 >
	The type of the alphabet when represented as a number (e.g. via to_rank()). More...

Detailed Descriptionexperimental-api

The protein structure alphabet of the characters "HGIEBTSCX".

.

The DSSP annotation links structure elements to protein sequences. Originally created with 7 letters as a file format for the DSSP program (https://swift.cmbi.umcn.nl/gv/dssp/), it is also used in the stockholm file format for structure alignments, extended by the characters C and X (https://en.wikipedia.org/wiki/Stockholm_format).

The letter abbreviations are as follows:

H = alpha helix B = beta bridge E = strand G = helix-3 I = helix-5 T = turn S = bend C = coil/loop X = unknown

Example

#include <seqan3/alphabet/structure/dssp9.hpp>
#include <seqan3/core/debug_stream.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::dssp9 letter{'H'_dssp9};
 
    letter.assign_char('B');
    seqan3::debug_stream << letter << '\n'; // prints "B"
 
    letter.assign_char('F'); // Unknown characters are implicitly converted to 'X'.
    seqan3::debug_stream << letter << '\n'; // prints "X"
}

This entity is experimental and subject to change in the future. Experimental since version 3.1.

Friends And Related Function Documentation

operator""_dssp9() [1/2] [experimental-api]

constexpr dssp9 operator""_dssp9 ( char const  ch )

experimental-apirelated

The seqan3::dssp9 char literal.

Parameters

[in]

ch

The character to represent as dssp.

Returns

seqan3::dssp9

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

#include <seqan3/alphabet/structure/dssp9.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    seqan3::dssp9 letter1{'('_dssp9};
    auto letter2 = '('_dssp9;
}

This entity is experimental and subject to change in the future. Experimental since version 3.1.

operator""_dssp9() [2/2] [experimental-api]

std::vector< dssp9 > operator""_dssp9 ( const char *  str, std::size_t  len  )

experimental-apirelated

The seqan3::dssp9 string literal.

Parameters

[in]	str	A pointer to the character string to assign.
[in]	len	The size of the character string to assign.

Returns

std::vector<seqan3::dssp9>

You can use this string literal to easily assign to std::vector<seqan3::dssp9>:

#include <seqan3/alphabet/structure/dssp9.hpp>
 
int main()
{
    using namespace seqan3::literals;
 
    std::vector<seqan3::dssp9> sequence1{"EHHHHT"_dssp9};
    std::vector<seqan3::dssp9> sequence2 = "EHHHHT"_dssp9;
    auto sequence3 = "EHHHHT"_dssp9;
}

This entity is experimental and subject to change in the future. Experimental since version 3.1.

---

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

• seqan3/alphabet/structure/dssp9.hpp