concept.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2022 deCODE Genetics
// Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2020, 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/biocpp/biocpp-core/blob/main/LICENSE.md
// -----------------------------------------------------------------------------------------------------
 
#pragma once
 
#include <bio/alphabet/concept.hpp>
 
// ============================================================================
// to_phred()
// ============================================================================
 
namespace bio::alphabet
{
 
inline constexpr auto to_phred = []<typename alph_t>(alph_t const a)
    requires(requires {
        {
            tag_invoke(custom::to_phred{}, a)
        } -> std::integral;
        requires noexcept(tag_invoke(custom::to_phred{}, a));
    })
{
    return tag_invoke(custom::to_phred{}, a);
};
 
template <typename alphabet_type>
    requires(requires {
                {
                    bio::alphabet::to_phred(std::declval<alphabet_type>())
                };
            })
using phred_t = decltype(bio::alphabet::to_phred(std::declval<alphabet_type>()));
 
// ============================================================================
// assign_phred_to()
// ============================================================================
 
inline constexpr auto assign_phred_to =
  []<typename alph_t>(bio::alphabet::phred_t<alph_t> const p, alph_t && a) -> alph_t
    requires(requires {
        {
            tag_invoke(custom::assign_phred_to{}, p, a)
        } -> std::same_as<alph_t &>;
        requires noexcept(tag_invoke(custom::assign_phred_to{}, p, a));
    })
{
    return tag_invoke(custom::assign_phred_to{}, p, a);
};
 
// ============================================================================
// bio::alphabet::quality
// ============================================================================
 
template <typename t>
concept quality = alphabet<t> && requires(t qual) {
    {
        bio::alphabet::to_phred(qual)
    };
};
 
// ============================================================================
// bio::alphabet::writable_quality
// ============================================================================
 
template <typename t>
concept writable_quality = writable_alphabet<t> && quality<t> && requires(t v, phred_t<t> c) {
    {
        bio::alphabet::assign_phred_to(c, v)
    };
};
 
} // namespace bio::alphabet