alphabet_tuple_base.hpp

Go to the documentation of this file.

// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2019, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2019, 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 <cassert>
#include <utility>

#include <meta/meta.hpp>

#include <seqan3/alphabet/concept.hpp>
#include <seqan3/alphabet/composite/detail.hpp>
#include <seqan3/alphabet/alphabet_base.hpp>
#include <seqan3/alphabet/detail/alphabet_proxy.hpp>
#include <seqan3/alphabet/quality/concept.hpp>
#include <seqan3/core/concept/core_language.hpp>
#include <seqan3/core/concept/tuple.hpp>
#include <seqan3/core/detail/int_types.hpp>
#include <seqan3/core/type_traits/pack.hpp>
#include <seqan3/core/type_traits/transformation_trait_or.hpp>
#include <seqan3/core/tuple_utility.hpp>
#include <seqan3/std/concepts>

namespace seqan3::detail
{

// anchor is false
template <typename tuple_t, typename tuple_derived_t, template <typename> typename fun_t, typename other_t>
inline bool constexpr one_component_is = false;


// default
template <typename ... tuple_comps,
          typename tuple_derived_t,
          template <typename> typename fun_t,
          typename other_t>
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       fun_t,
                                       other_t> =
    !meta::empty<meta::find_if<meta::list<tuple_comps...>, fun_t<other_t>>>::value;
    //TODO do without meta

// guard against self
template <typename ... tuple_comps,
          typename tuple_derived_t,
          template <typename> typename fun_t>
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       fun_t,
                                       alphabet_tuple_base<tuple_derived_t, tuple_comps...>> = false;

// guard against self (derived)
template <typename ... tuple_comps,
          typename tuple_derived_t,
          template <typename> typename fun_t>
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       fun_t,
                                       tuple_derived_t> = false;

// guard against types that have conversion operators to derived
template <typename ... tuple_comps,
          typename tuple_derived_t,
          template <typename> typename fun_t,
          typename other_t>
    requires ConvertibleToByMember<other_t, tuple_derived_t>
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       fun_t,
                                       other_t> = false;

// guard against components
template <typename ... tuple_comps,
          typename tuple_derived_t,
          template <typename> typename fun_t,
          typename other_t>
    requires type_in_pack_v<other_t, tuple_comps...>
//     requires meta::in<recursive_tuple_components<alphabet_tuple_base<tuple_derived_t, tuple_comps...>>::type,
//                       other_t>::value
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       fun_t,
                                       other_t> = false;

// during comparisons, guard against types that could be converted to self (because that is preferred)
// (may not be done during assignment or construction because of recursiveness)
template <typename ... tuple_comps,
          typename tuple_derived_t,
          typename other_t>
    requires ImplicitlyConvertibleTo<other_t, tuple_derived_t>
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       weakly_equality_comparable_with,
                                       other_t> = false;
template <typename ... tuple_comps,
          typename tuple_derived_t,
          typename other_t>
    requires ImplicitlyConvertibleTo<other_t, tuple_derived_t>
inline bool constexpr one_component_is<alphabet_tuple_base<tuple_derived_t, tuple_comps...>,
                                       tuple_derived_t,
                                       weakly_ordered_with,
                                       other_t> = false;

} // namespace seqan3::detail

namespace seqan3
{

// forwards
template <typename t>
decltype(auto) get();

template <size_t i>
decltype(auto) get();

template <typename derived_type,
          typename ...component_types>
    requires (detail::WritableConstexprSemialphabet<component_types> && ...) &&
             (!std::is_reference_v<component_types> && ...)
class alphabet_tuple_base :
    public alphabet_base<derived_type,
                         (1 * ... * alphabet_size<component_types>),
                         void> // no char type, because this is only semi_alphabet
{
private:
    using base_t = alphabet_base<derived_type,
                                (1 * ... * alphabet_size<component_types>),
                                void>; // no char type, because this is only semi_alphabet

    using component_list = meta::list<component_types...>;

    template <typename type>
    static constexpr bool is_component =
        meta::in<component_list, type>::value;

    template <typename type>
    static constexpr bool is_unique_component =
        is_component<type> &&
        (meta::find_index<component_list, type>::value == meta::reverse_find_index<component_list, type>::value);

    template <typename alphabet_type, size_t index>
    class component_proxy : public alphabet_proxy<component_proxy<alphabet_type, index>, alphabet_type>
    {
    private:
        using base_t = alphabet_proxy<component_proxy<alphabet_type, index>, alphabet_type>;
        friend base_t;

        alphabet_tuple_base *parent;

        constexpr void on_update() noexcept
        {
            parent->assign_rank(
                parent->to_rank()
                - parent->template to_component_rank<index>() * alphabet_tuple_base::cummulative_alph_sizes[index]
                + to_rank() * alphabet_tuple_base::cummulative_alph_sizes[index]);
        }

        using typename base_t::rank_type;
        using typename base_t::char_type;
        using typename base_t::phred_type;

    public:
        //Import from base type:
        using base_t::to_rank;
        using base_t::alphabet_size;
        using base_t::operator=;

        constexpr component_proxy() : base_t{}, parent{} {}                        
        constexpr component_proxy(component_proxy const &) = default;              
        constexpr component_proxy(component_proxy &&) = default;                   
        constexpr component_proxy & operator=(component_proxy const &) = default;  
        constexpr component_proxy & operator=(component_proxy &&) = default;       
        ~component_proxy() = default;                                              

        constexpr component_proxy(alphabet_type const l, alphabet_tuple_base & p) :
            base_t{l}, parent{&p}
        {}

        // Does not inherit the base's constructor for alphabet_type so as not to cause ambiguity
    };

    constexpr alphabet_tuple_base() noexcept : base_t{} {}
    constexpr alphabet_tuple_base(alphabet_tuple_base const &) = default;
    constexpr alphabet_tuple_base(alphabet_tuple_base &&) = default;
    constexpr alphabet_tuple_base & operator=(alphabet_tuple_base const &) = default;
    constexpr alphabet_tuple_base & operator=(alphabet_tuple_base &&) = default;
    ~alphabet_tuple_base() = default;

    using base_t::base_t;

    friend derived_type;

    // Import from base:
    using typename base_t::rank_type;

public:
    // Import from base:
    using base_t::alphabet_size;
    using base_t::to_rank;
    using base_t::assign_rank;

    using seqan3_tuple_components = component_list;
    using seqan3_recursive_tuple_components =
        meta::concat<component_list,
                     detail::transformation_trait_or_t<detail::recursive_tuple_components<component_types>,
                                                       meta::list<>>...>;

    constexpr alphabet_tuple_base(component_types ... components) noexcept
    {
        assign_rank(rank_sum_helper(components..., std::make_index_sequence<sizeof...(component_types)>{}));
    }

    template <typename component_type>
        requires is_unique_component<component_type>
    constexpr explicit alphabet_tuple_base(component_type const alph) noexcept : alphabet_tuple_base{}
    {
        get<component_type>(*this) = alph;
    }

    template <typename indirect_component_type>
       requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::implicitly_convertible_from, indirect_component_type>
    constexpr explicit alphabet_tuple_base(indirect_component_type const alph) noexcept : alphabet_tuple_base{}
    {
       using component_type = meta::front<meta::find_if<component_list, detail::implicitly_convertible_from<indirect_component_type>>>;
       component_type tmp(alph); // delegate construction
       get<component_type>(*this) = tmp;
    }

    template <typename indirect_component_type>
       requires !detail::one_component_is<alphabet_tuple_base, derived_type, detail::implicitly_convertible_from, indirect_component_type> &&
                 detail::one_component_is<alphabet_tuple_base, derived_type, detail::constructible_from, indirect_component_type>
    constexpr explicit alphabet_tuple_base(indirect_component_type const alph) noexcept : alphabet_tuple_base{}
    {
       using component_type = meta::front<meta::find_if<component_list, detail::constructible_from<indirect_component_type>>>;
       component_type tmp(alph); // delegate construction
       get<component_type>(*this) = tmp;
    }

    template <typename component_type>
        requires is_unique_component<component_type>
    constexpr derived_type & operator=(component_type const alph) noexcept
    {
        get<component_type>(*this) = alph;
        return static_cast<derived_type &>(*this);
    }

    template <typename indirect_component_type>
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::assignable_from, indirect_component_type>
    constexpr derived_type & operator=(indirect_component_type const alph) noexcept
    {
        using component_type = meta::front<meta::find_if<component_list, detail::assignable_from<indirect_component_type>>>;
        get<component_type>(*this) = alph; // delegate assignment
        return static_cast<derived_type &>(*this);
    }
    // If not assignable but implicit convertible, convert first and assign afterwards
    template <typename indirect_component_type>
        requires !detail::one_component_is<alphabet_tuple_base, derived_type, detail::assignable_from, indirect_component_type> &&
                 detail::one_component_is<alphabet_tuple_base, derived_type, detail::implicitly_convertible_from, indirect_component_type>
    constexpr derived_type & operator=(indirect_component_type const alph) noexcept
    {
        using component_type = meta::front<meta::find_if<component_list, detail::implicitly_convertible_from<indirect_component_type>>>;
        component_type tmp(alph);
        get<component_type>(*this) = tmp;
        return static_cast<derived_type &>(*this);
    }

    template <size_t index>
    friend constexpr auto get(alphabet_tuple_base & l) noexcept
    {
        static_assert(index < sizeof...(component_types), "Index out of range.");

        using t = meta::at_c<component_list, index>;
        t val{};

        using seqan3::assign_rank_to;
        assign_rank_to(l.to_component_rank<index>(), val);

        return component_proxy<t, index>{val, l};
    }

    template <typename type>
    friend constexpr auto get(alphabet_tuple_base & l) noexcept
        requires is_unique_component<type>
    {
        return get<meta::find_index<component_list, type>::value>(l);
    }

    template <size_t index>
    friend constexpr auto get(alphabet_tuple_base const & l) noexcept
    {
        static_assert(index < sizeof...(component_types), "Index out of range.");

        using t = meta::at_c<component_list, index>;
        t val{};

        using seqan3::assign_rank_to;
        assign_rank_to(l.to_component_rank<index>(), val);

        return val;
    }

    template <typename type>
    friend constexpr type get(alphabet_tuple_base const & l) noexcept
        requires is_unique_component<type>
    {
        return get<meta::find_index<component_list, type>::value>(l);
    }

    template <typename type>
    constexpr operator type() const noexcept
        requires is_unique_component<type>
    {
        return get<type>(*this);
    }

    template <typename indirect_component_type>
    constexpr bool operator==(indirect_component_type const rhs) const noexcept
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::weakly_equality_comparable_with, indirect_component_type>
    {
        using component_type = meta::front<meta::find_if<component_list, detail::weakly_equality_comparable_with<indirect_component_type>>>;
        return get<component_type>(*this) == rhs;
    }

    template <typename indirect_component_type>
    constexpr bool operator!=(indirect_component_type const rhs) const noexcept
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::weakly_equality_comparable_with, indirect_component_type>
    {
        using component_type = meta::front<meta::find_if<component_list, detail::weakly_equality_comparable_with<indirect_component_type>>>;
        return get<component_type>(*this) != rhs;
    }

    template <typename indirect_component_type>
    constexpr bool operator<(indirect_component_type const rhs) const noexcept
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::weakly_ordered_with, indirect_component_type>
    {
        using component_type = meta::front<meta::find_if<component_list, detail::weakly_ordered_with<indirect_component_type>>>;
        return get<component_type>(*this) < rhs;
    }

    template <typename indirect_component_type>
    constexpr bool operator>(indirect_component_type const rhs) const noexcept
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::weakly_ordered_with, indirect_component_type>
    {
        using component_type = meta::front<meta::find_if<component_list, detail::weakly_ordered_with<indirect_component_type>>>;
        return get<component_type>(*this) > rhs;
    }

    template <typename indirect_component_type>
    constexpr bool operator<=(indirect_component_type const rhs) const noexcept
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::weakly_ordered_with, indirect_component_type>
    {
        using component_type = meta::front<meta::find_if<component_list, detail::weakly_ordered_with<indirect_component_type>>>;
        return get<component_type>(*this) <= rhs;
    }

    template <typename indirect_component_type>
    constexpr bool operator>=(indirect_component_type const rhs) const noexcept
        requires detail::one_component_is<alphabet_tuple_base, derived_type, detail::weakly_ordered_with, indirect_component_type>
    {
        using component_type = meta::front<meta::find_if<component_list, detail::weakly_ordered_with<indirect_component_type>>>;
        return get<component_type>(*this) >= rhs;
    }

private:
    template <size_t index>
    constexpr rank_type to_component_rank() const noexcept
    {
        return (to_rank() / cummulative_alph_sizes[index]) % seqan3::alphabet_size<meta::at_c<component_list, index>>;
    }

    static constexpr std::array<rank_type, component_list::size()> cummulative_alph_sizes
    {
        [] () constexpr
        {
            // create array (1, |sigma1|, |sigma1|*|sigma2|,  ... ,  |sigma1|*...*|sigmaN|)
            std::array<rank_type, component_list::size() + 1> ret{};
            ret[0] = 1;
            size_t count = 1;
            meta::for_each(meta::reverse<component_list>{}, [&] (auto alph) constexpr
            {
                ret[count] = static_cast<rank_type>(seqan3::alphabet_size<decltype(alph)> * ret[count - 1]);
                ++count;
            });

            // reverse and strip one: (|sigma1|*...*|sigmaN-1|, ... |sigma1|*|sigma2|, |sigma1|, 1)
            // reverse order guarantees that the first alphabet is the most significant rank contributer
            // resulting in element-wise alphabetical ordering on comparison
            std::array<rank_type, component_list::size()> ret2{};
            for (size_t i = 0; i < component_list::size(); ++i)
                ret2[i] = ret[component_list::size() - i - 1];

            return ret2;
        }()
    };

    template <std::size_t ...idx>
    static constexpr rank_type rank_sum_helper(component_types ... components, std::index_sequence<idx...> const &) noexcept
    {
        using seqan3::to_rank;
        return ((to_rank(components) * cummulative_alph_sizes[idx]) + ...);
    }
};

template <typename indirect_component_type, typename derived_type, typename ...component_types>
    requires detail::WeaklyEqualityComparableByMembersWith<derived_type, indirect_component_type> &&
             !detail::WeaklyEqualityComparableByMembersWith<indirect_component_type, derived_type>
constexpr bool operator==(indirect_component_type const lhs,
                          alphabet_tuple_base<derived_type, component_types...> const rhs) noexcept
{
    return rhs == lhs;
}

template <typename indirect_component_type, typename derived_type, typename ...indirect_component_types>
    requires detail::WeaklyEqualityComparableByMembersWith<derived_type, indirect_component_type> &&
             !detail::WeaklyEqualityComparableByMembersWith<indirect_component_type, derived_type>
constexpr bool operator!=(indirect_component_type const lhs,
                          alphabet_tuple_base<derived_type, indirect_component_types...> const rhs) noexcept
{
    return rhs != lhs;
}

template <typename indirect_component_type, typename derived_type, typename ...indirect_component_types>
    requires detail::WeaklyOrderedByMembersWith<derived_type, indirect_component_type> &&
             !detail::WeaklyOrderedByMembersWith<indirect_component_type, derived_type>
constexpr bool operator<(indirect_component_type const lhs,
                         alphabet_tuple_base<derived_type, indirect_component_types...> const rhs) noexcept
{
    return rhs > lhs;
}

template <typename indirect_component_type, typename derived_type, typename ...indirect_component_types>
    requires detail::WeaklyOrderedByMembersWith<derived_type, indirect_component_type> &&
             !detail::WeaklyOrderedByMembersWith<indirect_component_type, derived_type>
constexpr bool operator>(indirect_component_type const lhs,
                         alphabet_tuple_base<derived_type, indirect_component_types...> const rhs) noexcept
{
    return rhs < lhs;
}

template <typename indirect_component_type, typename derived_type, typename ...indirect_component_types>
    requires detail::WeaklyOrderedByMembersWith<derived_type, indirect_component_type> &&
             !detail::WeaklyOrderedByMembersWith<indirect_component_type, derived_type>
constexpr bool operator<=(indirect_component_type const lhs,
                          alphabet_tuple_base<derived_type, indirect_component_types...> const rhs) noexcept
{
    return rhs >= lhs;
}

template <typename indirect_component_type, typename derived_type, typename ...indirect_component_types>
    requires detail::WeaklyOrderedByMembersWith<derived_type, indirect_component_type> &&
             !detail::WeaklyOrderedByMembersWith<indirect_component_type, derived_type>
constexpr bool operator>=(indirect_component_type const lhs,
                          alphabet_tuple_base<derived_type, indirect_component_types...> const rhs) noexcept
{
    return rhs <= lhs;
}

} // namespace seqan3

namespace std
{

template <std::size_t i, seqan3::detail::AlphabetTupleBase tuple_t>
struct tuple_element<i, tuple_t>
{
    using type = meta::at_c<typename tuple_t::seqan3_tuple_components, i>;
};

template <seqan3::detail::AlphabetTupleBase tuple_t>
struct tuple_size<tuple_t> :
    public std::integral_constant<size_t, tuple_t::seqan3_tuple_components::size()>
{};

} // namespace std