alphabet_variant.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 <algorithm>
#include <array>
#include <utility>
#include <cassert>
#include <variant>

#include <meta/meta.hpp>

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

namespace seqan3::detail
{

// default is false
template <typename variant_t,
          template <typename> typename fun_t,
          typename target_t>
inline bool constexpr one_alternative_is = false;


// actual implementation
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         target_t>
 = !meta::empty<meta::find_if<meta::list<alternatives...>, fun_t<target_t>>>::value;

// guard against self
template <typename ... alternatives,
          template <typename> typename fun_t>
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         alphabet_variant<alternatives...>> = false;

// guard against types convertible to self without needing self's constructors
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
    requires ConvertibleToByMember<target_t, alphabet_variant<alternatives...>>
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         target_t> = false;

// guard against tuple composites that contain the variant somewhere (they can implicitly convert at source)
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
    requires AlphabetTupleBase<target_t> &&
             meta::in<detail::transformation_trait_or_t<recursive_tuple_components<target_t>, meta::list<>>,
                      alphabet_variant<alternatives...>>::value
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         target_t> = false;

// guard against alternatives
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
    requires type_in_pack_v<target_t, alternatives...>
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         target_t> = false;

// guard against alternatives (LHS and RHS switched)
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
    requires type_in_pack_v<target_t, alternatives...>
inline bool constexpr one_alternative_is<target_t,
                                         fun_t,
                                         alphabet_variant<alternatives...>> = false;

// guard against ranges and iterators over self to prevent recursive instantiation
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
    //NO, it's not possible to use the value_type type trait here
    requires requires { std::Same<typename target_t::value_type, alphabet_variant<alternatives...>>; }
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         target_t> = false;

// guard against pairs/tuples that *might* contain self to prevent recursive instantiation
// (applying TupleLike unfortunately does not work because it itself starts recursive instantiation)
template <typename ... alternatives,
          template <typename> typename fun_t,
          typename target_t>
    requires TupleSize<target_t> && !AlphabetTupleBase<target_t>
inline bool constexpr one_alternative_is<alphabet_variant<alternatives...>,
                                         fun_t,
                                         target_t> = false;


} // namespace seqan3::detail

namespace seqan3
{

template <typename ...alternative_types>
    requires (detail::WritableConstexprAlphabet<alternative_types> && ...) &&
             (!std::is_reference_v<alternative_types> && ...) &&
             (sizeof...(alternative_types) >= 2)
             //TODO same char_type
class alphabet_variant : public alphabet_base<alphabet_variant<alternative_types...>,
                                               (static_cast<size_t>(alphabet_size<alternative_types>) + ...),
                                               char> //TODO underlying char t

{
private:
    using base_t = alphabet_base<alphabet_variant<alternative_types...>,
                                                   (static_cast<size_t>(alphabet_size<alternative_types>) + ...),
                                                   char>;
    friend base_t;

    using alternatives = meta::list<alternative_types...>;

    static_assert(std::Same<alternatives, meta::unique<alternatives>>,
                  "All types in a alphabet_variant must be distinct.");

    using typename base_t::char_type;
    using typename base_t::rank_type;
public:
    using base_t::alphabet_size;
    using base_t::to_char;
    using base_t::to_rank;
    using base_t::assign_rank;

    template <typename alternative_t>
    static constexpr bool holds_alternative() noexcept
    {
        return detail::type_in_pack_v<alternative_t, alternative_types...>;
    }

    constexpr alphabet_variant()                                     noexcept = default; 
    constexpr alphabet_variant(alphabet_variant const &)             noexcept = default; 
    constexpr alphabet_variant(alphabet_variant &&)                  noexcept = default; 
    constexpr alphabet_variant & operator=(alphabet_variant const &) noexcept = default; 
    constexpr alphabet_variant & operator=(alphabet_variant &&)      noexcept = default; 
    ~alphabet_variant()                                              noexcept = default; 

    template <typename alternative_t>
        requires holds_alternative<alternative_t>()
    constexpr alphabet_variant(alternative_t const & alternative) noexcept
    {
        assign_rank(rank_by_type_(alternative));
    }

    template <typename indirect_alternative_t>
        requires !detail::one_alternative_is<alphabet_variant,
                                             detail::implicitly_convertible_from,
                                             indirect_alternative_t> &&
                 detail::one_alternative_is<alphabet_variant,
                                            detail::constructible_from,
                                            indirect_alternative_t>
    constexpr alphabet_variant(indirect_alternative_t const & rhs) noexcept
    {
        assign_rank(rank_by_type_(meta::front<meta::find_if<alternatives,
                                                            detail::constructible_from<indirect_alternative_t>>>(rhs)));
    }

    template <typename indirect_alternative_t>
        requires detail::one_alternative_is<alphabet_variant,
                                            detail::implicitly_convertible_from,
                                            indirect_alternative_t>
    constexpr alphabet_variant(indirect_alternative_t const & rhs) noexcept
    {
        assign_rank(
            rank_by_type_(
                meta::front<meta::find_if<alternatives,
                                          detail::implicitly_convertible_from<indirect_alternative_t>>>(rhs)));
    }

    template <typename indirect_alternative_t>
        requires !detail::one_alternative_is<alphabet_variant,
                                             detail::implicitly_convertible_from,
                                             indirect_alternative_t> &&             // constructor takes care
                 !detail::one_alternative_is<alphabet_variant,
                                             detail::constructible_from,
                                             indirect_alternative_t> &&             // constructor takes care
                 detail::one_alternative_is<alphabet_variant,
                                            detail::assignable_from,
                                            indirect_alternative_t>
    constexpr alphabet_variant & operator=(indirect_alternative_t const & rhs) noexcept
    {
        using alternative_t = meta::front<meta::find_if<alternatives, detail::assignable_from<indirect_alternative_t>>>;
        alternative_t alternative{};
        alternative = rhs;
        assign_rank(rank_by_type_(alternative));
        return *this;
    }

    template <size_t index>
    constexpr bool is_alternative() const noexcept
    {
        static_assert(index < alphabet_size, "The alphabet_variant contains less alternatives than you are checking.");
        return (to_rank() >= partial_sum_sizes[index]) && (to_rank() < partial_sum_sizes[index + 1]);
    }

    template <size_t index>
    constexpr auto convert_to() const
    {
        return convert_impl<index, true>();
    }

    template <size_t index>
    constexpr auto convert_unsafely_to() const noexcept
    {
        return convert_impl<index, false>();
    }

    template <typename alternative_t>
    constexpr bool is_alternative() const noexcept
        requires holds_alternative<alternative_t>()
    {
        constexpr size_t index = meta::find_index<alternatives, alternative_t>::value;
        return is_alternative<index>();
    }

    template <typename alternative_t>
    constexpr alternative_t convert_to() const
        requires holds_alternative<alternative_t>()
    {
        constexpr size_t index = meta::find_index<alternatives, alternative_t>::value;
        return convert_impl<index, true>();
    }

    template <typename alternative_t>
    constexpr alternative_t convert_unsafely_to() const noexcept
        requires holds_alternative<alternative_t>()
    {
        constexpr size_t index = meta::find_index<alternatives, alternative_t>::value;
        return convert_impl<index, false>();
    }

    template <typename alternative_t>
    constexpr bool operator==(alternative_t const rhs) const noexcept
        requires holds_alternative<alternative_t>()
    {
        return is_alternative<alternative_t>() && (convert_unsafely_to<alternative_t>() == rhs);
    }

    template <typename alternative_t>
    constexpr bool operator!=(alternative_t const rhs) const noexcept
        requires holds_alternative<alternative_t>()
    {
        return !operator==(rhs);
    }

    template <typename indirect_alternative_type>
    constexpr bool operator==(indirect_alternative_type const rhs) const noexcept
        requires detail::one_alternative_is<alphabet_variant,
                                            detail::weakly_equality_comparable_with,
                                            indirect_alternative_type>
    {
        using alternative_t =
            meta::front<meta::find_if<alternatives,
                                      detail::weakly_equality_comparable_with<indirect_alternative_type>>>;
        return is_alternative<alternative_t>() && (convert_unsafely_to<alternative_t>() == rhs);
    }

    template <typename indirect_alternative_type>
    constexpr bool operator!=(indirect_alternative_type const rhs) const noexcept
        requires detail::one_alternative_is<alphabet_variant,
                                            detail::weakly_equality_comparable_with,
                                            indirect_alternative_type>
    {
        return !operator==(rhs);
    }

protected:

    template <size_t index, bool throws>
    constexpr auto convert_impl() const noexcept(!throws) -> meta::at_c<alternatives, index>
    {
        static_assert(index < alphabet_size, "The alphabet_variant contains less alternatives than you are checking.");
        using alternative_t = meta::at_c<alternatives, index>;

        if constexpr (throws)
        {
            if (!is_alternative<index>()) // [[unlikely]]
            {
                throw std::bad_variant_access{};
            }
        }

        using seqan3::assign_rank_to;
        return assign_rank_to(to_rank() - partial_sum_sizes[index], alternative_t{});
    }

    static constexpr std::array partial_sum_sizes = []() constexpr
    {
        constexpr size_t N = sizeof...(alternative_types) + 1;

        std::array<rank_type, N> partial_sum{0, seqan3::alphabet_size<alternative_types>...};
        for (size_t i = 1u; i < N; ++i)
            partial_sum[i] += partial_sum[i-1];

        return partial_sum;
    }();

    static constexpr std::array<char_type, alphabet_size> rank_to_char = []() constexpr
    {
        // Explicitly writing assign_rank_to_char within assign_rank_to_char
        // causes this bug (g++-7 and g++-8):
        // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=84684
        auto assign_rank_to_char = [](auto alternative, size_t rank) constexpr
        {
            return seqan3::to_char(seqan3::assign_rank_to(rank, alternative));
        };

        auto assign_value_to_char = [assign_rank_to_char] (auto alternative, auto & value_to_char, auto & value) constexpr
        {
            using alternative_t = std::decay_t<decltype(alternative)>;
            for (size_t i = 0u; i < seqan3::alphabet_size<alternative_t>; ++i, ++value)
                value_to_char[value] = assign_rank_to_char(alternative, i);
        };

        unsigned value = 0u;
        std::array<char_type, alphabet_size> value_to_char{};

        // initializer lists guarantee sequencing;
        // the following expression behaves as:
        // for(auto alternative: alternative_types)
        //    assign_rank_to_char(alternative, rank_to_char, value);
        ((assign_value_to_char(alternative_types{}, value_to_char, value)),...);

        return value_to_char;
    }();

    template <size_t index, typename alternative_t>
        requires holds_alternative<alternative_t>()
    static constexpr rank_type rank_by_index_(alternative_t const & alternative) noexcept
    {
        return partial_sum_sizes[index] + static_cast<rank_type>(seqan3::to_rank(alternative));
    }

    template <typename alternative_t>
        requires holds_alternative<alternative_t>()
    static constexpr rank_type rank_by_type_(alternative_t const & alternative) noexcept
    {
        constexpr size_t index = meta::find_index<alternatives, alternative_t>::value;
        return rank_by_index_<index>(alternative);
    }

    static constexpr std::array char_to_rank = []() constexpr
    {
        constexpr size_t table_size = 1 << (sizeof(char_type) * 8);

        std::array<rank_type, table_size> char_to_rank{};

        for (size_t i = 0u; i < table_size; ++i)
        {
            char_type chr = static_cast<char_type>(i);
            bool there_was_no_valid_representation{true};

            meta::for_each(alternatives{}, [&] (auto && alt)
            {
                using alt_type = remove_cvref_t<decltype(alt)>;

                if (there_was_no_valid_representation && char_is_valid_for<alt_type>(chr))
                {
                    there_was_no_valid_representation = false;
                    char_to_rank[i] = rank_by_type_(assign_char_to(chr, alt_type{}));
                }
            });

            if (there_was_no_valid_representation)
                char_to_rank[i] = rank_by_type_(assign_char_to(chr, meta::front<alternatives>{}));
        }

        return char_to_rank;
    }();

    static constexpr bool char_is_valid(char_type const chr) noexcept
    {
        bool is_valid{false};

        meta::for_each(alternatives{}, [&] (auto && alt)
        {
            if (char_is_valid_for<remove_cvref_t<decltype(alt)>>(chr))
                is_valid = true;
        });

        return is_valid;
    }
};

template <typename lhs_t, typename ...alternative_types>
constexpr bool operator==(lhs_t const lhs, alphabet_variant<alternative_types...> const rhs) noexcept
    requires detail::WeaklyEqualityComparableByMembersWith<alphabet_variant<alternative_types...>, lhs_t> &&
             !detail::WeaklyEqualityComparableByMembersWith<lhs_t, alphabet_variant<alternative_types...>>
{
    return rhs == lhs;
}

template <typename lhs_t, typename ...alternative_types>
constexpr bool operator!=(lhs_t const lhs, alphabet_variant<alternative_types...> const rhs) noexcept
    requires detail::WeaklyEqualityComparableByMembersWith<alphabet_variant<alternative_types...>, lhs_t> &&
             !detail::WeaklyEqualityComparableByMembersWith<lhs_t, alphabet_variant<alternative_types...>>
{
    return rhs != lhs;
}

} // namespace seqan3