combine_factors.hpp

Go to the documentation of this file.

#ifndef SCRAN_AGGREGATE_COMBINE_FACTORS_HPP
#define SCRAN_AGGREGATE_COMBINE_FACTORS_HPP
 
#include <algorithm>
#include <vector>
#include <map>
#include <unordered_map>
#include <cstddef>
 
#include "clean_factor.hpp"
 
#include "sanisizer/sanisizer.hpp"
 
namespace scran_aggregate {
 
template<typename Factor_, typename Combined_>
std::vector<std::vector<Factor_> > combine_factors(std::size_t n, const std::vector<const Factor_*>& factors, Combined_* combined) {
    auto nfac = factors.size();
    auto output = sanisizer::create<std::vector<std::vector<Factor_> > >(nfac);
 
    // Handling the special cases.
    if (nfac == 0) {
        std::fill_n(combined, n, 0);
        return output;
    }
    if (nfac == 1) {
        output[0] = clean_factor(n, factors.front(), combined);
        return output;
    }
 
    // Creating a hashmap on the combinations of each factor.
    struct Combination {
        Combination(std::size_t i) : index(i) {}
        std::size_t index;
    };
 
    auto unique = [&]{ // scoping this in an IIFE to release map memory sooner.
        // Using a map with a custom comparator that uses the index
        // of first occurrence of each factor as the key. Currently using a map
        // to (i) avoid issues with collisions of combined hashes and (ii)
        // avoid having to write more code for sorting a vector of arrays.
        auto cmp = [&](const Combination& left, const Combination& right) -> bool {
            for (auto curf : factors) {
                if (curf[left.index] < curf[right.index]) {
                    return true;
                } else if (curf[left.index] > curf[right.index]) {
                    return false;
                }
            }
            return false;
        };
 
        auto eq = [&](const Combination& left, const Combination& right) -> bool {
            for (auto curf : factors) {
                if (curf[left.index] != curf[right.index]) {
                    return false;
                }
            }
            return true;
        };
 
        std::map<Combination, Combined_, decltype(cmp)> mapping(std::move(cmp));
        for (decltype(n) i = 0; i < n; ++i) {
            Combination current(i);
            auto mIt = mapping.find(current);
            if (mIt == mapping.end() || !eq(mIt->first, current)) {
                Combined_ alt = mapping.size();
                mapping.insert(mIt, std::make_pair(current, alt));
                combined[i] = alt;
            } else {
                combined[i] = mIt->second;
            }
        }
 
        return std::vector<std::pair<Combination, Combined_> >(mapping.begin(), mapping.end());
    }();
 
    // Remapping to a sorted set.
    auto nuniq = unique.size();
    for (auto& ofac : output) {
        ofac.reserve(nuniq);
    }
    auto remapping = sanisizer::create<std::vector<Combined_> >(nuniq);
    for (decltype(nuniq) u = 0; u < nuniq; ++u) {
        auto ix = unique[u].first.index;
        for (decltype(nfac) f = 0; f < nfac; ++f) {
            output[f].push_back(factors[f][ix]);
        }
        remapping[unique[u].second] = u;
    }
 
    // Mapping each cell to its sorted combination.
    for (decltype(n) i = 0; i < n; ++i) {
        combined[i] = remapping[combined[i]];
    }
 
    return output;
}
 
template<typename Factor_, typename Number_, typename Combined_>
std::vector<std::vector<Factor_> > combine_factors_unused(std::size_t n, const std::vector<std::pair<const Factor_*, Number_> >& factors, Combined_* combined) {
    auto nfac = factors.size();
    auto output = sanisizer::create<std::vector<std::vector<Factor_> > >(nfac);
 
    // Handling the special cases.
    if (nfac == 0) {
        std::fill_n(combined, n, 0);
        return output;
    }
    if (nfac == 1) {
        output[0].resize(factors[0].second);
        std::iota(output[0].begin(), output[0].end(), static_cast<Combined_>(0));
        std::copy_n(factors[0].first, n, combined);
        return output;
    }
 
    // We iterate from back to front, where the first factor is the slowest changing.
    std::copy_n(factors[nfac - 1].first, n, combined); 
    Combined_ ncombos = factors[nfac - 1].second;
    for (decltype(nfac) f = nfac - 1; f > 0; --f) {
        const auto& finfo = factors[f - 1];
        auto next_ncombos = sanisizer::product<Combined_>(ncombos, finfo.second);
        auto ff = finfo.first;
        for (decltype(n) i = 0; i < n; ++i) {
            combined[i] += ncombos * ff[i];
        }
        ncombos = next_ncombos;
    }
 
    sanisizer::cast<decltype(output[0].size())>(ncombos); // check that we can actually make the output vectors.
    Combined_ outer_repeats = ncombos;
    Combined_ inner_repeats = 1;
    for (decltype(nfac) f = nfac; f > 0; --f) {
        auto& out = output[f - 1];
        out.reserve(ncombos);
 
        const auto& finfo = factors[f - 1];
        Combined_ initial_size = inner_repeats * finfo.second;
        out.resize(initial_size);
 
        if (inner_repeats == 1) {
            std::iota(out.begin(), out.end(), static_cast<Combined_>(0));
        } else {
            auto oIt = out.begin();
            for (Number_ l = 0; l < finfo.second; ++l) {
                std::fill_n(oIt, inner_repeats, l);
                oIt += inner_repeats;
            }
        }
        inner_repeats = initial_size;
 
        outer_repeats /= finfo.second;
        for (Combined_ r = 1; r < outer_repeats; ++r) {
            out.insert(out.end(), out.begin(), out.begin() + initial_size);
        }
    }
 
    return output;
}
 
}
 
#endif