Program Listing for File debug_details.hpp

↰ Return to documentation for file (fwdpp/internal/debug_details.hpp)

#ifndef FWDPP_INTERNAL_DEBUG_DETAILS_HPP
#define FWDPP_INTERNAL_DEBUG_DETAILS_HPP

#include <vector>
#include <algorithm>
#include <stdexcept>
#include <fwdpp/forward_types.hpp>
#include <fwdpp/poptypes/tags.hpp>

/* We ignore unused variable warnings in this
 * file.  In release mode, the functions are empty,
 * and will result in loads of unnecessary warnings
 */
#if defined(__clang__) && defined(__llvm__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-parameter"
#elif defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif

namespace fwdpp
{
    namespace debug
    {
        namespace detail
        {
            template <typename GenomeContainerType>
            void
            validate_sum_haploid_genome_counts(
                const GenomeContainerType &haploid_genomes, const uint_t expected_sum)
            {
#ifndef NDEBUG
                uint_t s = 0;
                for (auto &g : haploid_genomes)
                    {
                        s += g.n;
                    }
                if (s != expected_sum)
                    {
                        throw std::runtime_error(
                            "FWDPP DEBUG: unexpectd sum of haploid_genome counts");
                    }
#endif
            }

            template <typename MutationContainerType, typename Iterator>
            void
            validate_mutation_key_ranges(const MutationContainerType &mutations,
                                         const Iterator beg, const Iterator end)
            {
#ifndef NDEBUG
                if (std::any_of(beg, end, [&mutations](const std::size_t m) {
                        return m >= mutations.size();
                    }))
                    {
                        throw std::runtime_error("FWDPP DEBUG: mutation key "
                                                 "out of range");
                    }
#endif
            }

            template <typename haploid_genome_t>
            void
            haploid_genome_is_extant(const haploid_genome_t &haploid_genome)
            {
#ifndef NDEBUG
                if (!haploid_genome.n)
                    {
                        throw std::runtime_error(
                            "FWDPP DEBUG: unexpected extinct haploid_genome");
                    }
#endif
            }

            template <typename haploid_genome_t, typename MutationContainerType>
            void
            haploid_genome_is_sorted(const haploid_genome_t &g,
                                     const MutationContainerType &m)
            {
#ifndef NDEBUG
                const auto comp = [&m](const size_t i, const size_t j) {
                    return m[i].pos < m[j].pos;
                };

                if (!std::is_sorted(g.mutations.begin(), g.mutations.end(), comp))
                    {
                        throw std::runtime_error(
                            "FWDPP DEBUG: neutral mutation keys not sorted");
                    }
                if (!std::is_sorted(g.smutations.begin(), g.smutations.end(), comp))
                    {
                        throw std::runtime_error(
                            "FWDPP DEBUG: selected mutation keys not sorted");
                    }
#endif
            }

            template <typename key_container, typename MutationContainerType>
            void
            haploid_genome_data_valid(const key_container &keys,
                                      const MutationContainerType &mutations,
                                      const std::vector<uint_t> &mutcounts,
                                      const bool expected_neutrality)
            {
#ifndef NDEBUG
                for (auto &k : keys)
                    {
                        if (!mutcounts[k])
                            {
                                throw std::runtime_error(
                                    "FWDPP DEBUG: extinct mutation in extant "
                                    "haploid_genome");
                            }
                        if (mutations[k].neutral != expected_neutrality)
                            {
                                throw std::runtime_error(
                                    "FWDPP DEBUG: mutation neutrality field "
                                    "incorrect");
                            }
                    }
#endif
            }

            template <typename haploid_genome_t, typename MutationContainerType>
            void
            haploid_genome_data_valid(const haploid_genome_t &g,
                                      const MutationContainerType &mutations,
                                      const std::vector<uint_t> &mutcounts)
            /*
      \brief Check that "neutral" and "non-neutral" mutations are where we
      expect them to be.
     */
            {
#ifndef NDEBUG
                detail::haploid_genome_is_sorted(g, mutations);
                detail::haploid_genome_data_valid(g.mutations, mutations, mutcounts,
                                                  true);
                detail::haploid_genome_data_valid(g.smutations, mutations, mutcounts,
                                                  false);
#endif
            }

            template <typename DiploidType, typename GenomeContainerType,
                      typename MutationContainerType>
            void
            validate_pop_data_common(const DiploidType &dip,
                                     const GenomeContainerType &haploid_genomes,
                                     const MutationContainerType &mutations,
                                     const std::vector<uint_t> &mutcounts)
            {
#ifndef NDEBUG
                if (!haploid_genomes[dip.first].n || !haploid_genomes[dip.second].n)
                    {
                        throw std::runtime_error(
                            "FWDPP DEBUG: haploid_genome count is zero");
                    }
                haploid_genome_is_sorted(haploid_genomes[dip.first], mutations);
                haploid_genome_is_sorted(haploid_genomes[dip.second], mutations);
                haploid_genome_data_valid(haploid_genomes[dip.first], mutations,
                                          mutcounts);
                haploid_genome_data_valid(haploid_genomes[dip.second], mutations,
                                          mutcounts);
#endif
            }

            template <typename poptype>
            void
            validate_pop_data(const poptype &pop, poptypes::DIPLOID_TAG)
            {
#ifndef NDEBUG
                for (const auto &d : pop.diploids)
                    {
                        validate_pop_data_common(d, pop.haploid_genomes, pop.mutations,
                                                 pop.mcounts);
                    }
#endif
            }

            template <typename poptype>
            void
            validate_pop_data(const poptype &pop)
            {
#ifndef NDEBUG
                validate_pop_data(pop, typename poptype::popmodel_t());
#endif
            }

            template <typename mutation_type>
            void
            check_mutation_neutrality(const mutation_type &mutation,
                                      const bool expected_neutrality)
            {
#ifndef NDEBUG
                if (mutation.neutral != expected_neutrality)
                    {
                        throw std::runtime_error(
                            "FWDPP DEBUG: mutation neutrality field "
                            "incorrect");
                    }
#endif
            }

            template <typename poptype>
            void
            all_haploid_genomes_extant(const poptype &pop,
                                       const fwdpp::poptypes::DIPLOID_TAG)
            {
#ifndef NEBUG
                for (auto &dip : pop.diploids)
                    {
                        if (pop.haploid_genomes[dip.first].n == 0
                            || pop.haploid_genomes[dip.second].n == 0)
                            {
                                throw std::runtime_error(
                                    "FWDPP DEBUG: diploid refers to "
                                    "extinct haploid_genome");
                            }
                    }
#endif
            }

        } // namespace detail
    }     // namespace debug
} // namespace fwdpp

#if defined(__clang__) && defined(__llvm__)
#pragma clang diagnostic pop
#elif defined(__GNUC__)
#pragma GCC diagnostic pop
#endif

#endif