aa27.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <vector>
 
#include <seqan3/alphabet/aminoacid/aminoacid_base.hpp>
#include <seqan3/alphabet/aminoacid/concept.hpp>
#include <seqan3/utility/char_operations/transform.hpp>
 
namespace seqan3
{
class aa27 : public aminoacid_base<aa27, 27>
{
private:
    using base_t = aminoacid_base<aa27, 27>;
 
    friend base_t;
    friend base_t::base_t;
 
public:
    constexpr aa27()                         noexcept = default; 
    constexpr aa27(aa27 const &)             noexcept = default; 
    constexpr aa27(aa27 &&)                  noexcept = default; 
    constexpr aa27 & operator=(aa27 const &) noexcept = default; 
    constexpr aa27 & operator=(aa27 &&)      noexcept = default; 
    ~aa27()                                  noexcept = default; 
 
    using base_t::base_t;
 
private:
    static constexpr char_type rank_to_char_table[alphabet_size]
    {
        'A',
        'B',
        'C',
        'D',
        'E',
        'F',
        'G',
        'H',
        'I',
        'J',
        'K',
        'L',
        'M',
        'N',
        'O',
        'P',
        'Q',
        'R',
        'S',
        'T',
        'U',
        'V',
        'W',
        'X',
        'Y',
        'Z',
        '*'
    };
 
    static constexpr std::array<rank_type, 256> char_to_rank_table
    {
        [] () constexpr
        {
            std::array<rank_type, 256> ret{};
 
            // initialize with UNKNOWN (std::array::fill unfortunately not constexpr)
            for (auto & c : ret)
                c = 23; // value of 'X'
 
            // reverse mapping for characters and their lowercase
            for (rank_type rnk = 0u; rnk < alphabet_size; ++rnk)
            {
                ret[static_cast<rank_type>(rank_to_char_table[rnk])] = rnk;
                ret[static_cast<rank_type>(to_lower(rank_to_char_table[rnk]))] = rnk;
            }
 
            return ret;
        }()
    };
 
    static constexpr char_type rank_to_char(rank_type const rank)
    {
        return rank_to_char_table[rank];
    }
 
    static constexpr rank_type char_to_rank(char_type const chr)
    {
        using index_t = std::make_unsigned_t<char_type>;
        return char_to_rank_table[static_cast<index_t>(chr)];
    }
};
 
// ------------------------------------------------------------------
// containers
// ------------------------------------------------------------------
 
using aa27_vector = std::vector<aa27>;
 
// ------------------------------------------------------------------
// literals
// ------------------------------------------------------------------
inline namespace literals
{
 
constexpr aa27 operator""_aa27(char const c) noexcept
{
    return aa27{}.assign_char(c);
}
 
inline aa27_vector operator""_aa27(char const * const s, size_t const n)
{
    aa27_vector r;
    r.resize(n);
 
    for (size_t i = 0; i < n; ++i)
        r[i].assign_char(s[i]);
 
    return r;
}
 
} // inline namespace literals
 
} // namespace seqan3