vect_generic.hpp

Go to the documentation of this file.

//****************************************************************************//
//     Copyright (C) 2016-2024 Florent Hivert <Florent.Hivert@lisn.fr>,       //
//                                                                            //
//  This file is part of HP-Combi <https://github.com/libsemigroups/HPCombi>  //
//                                                                            //
//  HP-Combi is free software: you can redistribute it and/or modify it       //
//  under the terms of the GNU General Public License as published by the     //
//  Free Software Foundation, either version 3 of the License, or             //
//  (at your option) any later version.                                       //
//                                                                            //
//  HP-Combi is distributed in the hope that it will be useful, but WITHOUT   //
//  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or     //
//  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License      //
//  for  more details.                                                        //
//                                                                            //
//  You should have received a copy of the GNU General Public License along   //
//  with HP-Combi. If not, see <https://www.gnu.org/licenses/>.               //
//****************************************************************************//

 
#ifndef HPCOMBI_VECT_GENERIC_HPP_
#define HPCOMBI_VECT_GENERIC_HPP_
 
#include <algorithm>         // for max, min, shuffle, sort
#include <array>             // for array
#include <cassert>           // for assert
#include <cstddef>           // for size_t
#include <cstdint>           // for uint64_t, int8_t, int64_t
#include <functional>        // for hash
#include <initializer_list>  // for initializer_list
#include <iomanip>           // for operator<<, setw
#include <memory>            // for hash
#include <ostream>           // for operator<<, basic_ostream
#include <random>            // for mt19937, random_devide
#include <type_traits>       // for is_trivial
 
#include "debug.hpp"  // for HPCOMBI_ASSERT
 
namespace HPCombi {
 
template <size_t Size, typename Expo = uint8_t>
std::array<Expo, Size> sorted_vect(std::array<Expo, Size> v) {
    std::sort(v.begin(), v.end());
    return v;
}

template <size_t Size, typename Expo = uint8_t> struct VectGeneric {
    static constexpr size_t size() { return Size; }
    using array = std::array<Expo, Size>;
    array v;
 
    VectGeneric() = default;
 
    VectGeneric(const array &_v) : v(_v) {}  // NOLINT
    VectGeneric(std::initializer_list<Expo> il, Expo def = 0) {
        HPCOMBI_ASSERT(il.size() <= Size);
        std::copy(il.begin(), il.end(), v.begin());
        std::fill(v.begin() + il.size(), v.end(), def);
    }
 
    Expo operator[](uint64_t i) const { return v[i]; }
    Expo &operator[](uint64_t i) { return v[i]; }
 
    size_t first_diff(const VectGeneric &u, size_t bound = Size) const {
        for (size_t i = 0; i < bound; i++)
            if (v[i] != u[i])
                return i;
        return Size;
    }
 
    size_t last_diff(const VectGeneric &u, size_t bound = Size) const {
        while (bound != 0) {
            --bound;
            if (u[bound] != v[bound])
                return bound;
        }
        return Size;
    }
 
    using value_type = Expo;
    using iterator = typename array::iterator;
    using const_iterator = typename array::const_iterator;
    iterator begin() { return v.begin(); }
    iterator end() { return v.end(); }
    const_iterator begin() const { return v.begin(); }
    const_iterator end() const { return v.end(); }
 
    bool operator==(const VectGeneric &u) const {
        return first_diff(u) == Size;
    }
    bool operator!=(const VectGeneric &u) const {
        return first_diff(u) != Size;
    }
 
    bool operator<(const VectGeneric &u) const {
        uint64_t diff = first_diff(u);
        return (diff != Size) && v[diff] < u[diff];
    }
 
    int8_t less_partial(const VectGeneric &u, int k) const {
        uint64_t diff = first_diff(u, k);
        return (diff == Size) ? 0 : int8_t(v[diff]) - int8_t(u[diff]);
    }
 
    VectGeneric permuted(const VectGeneric &u) const {
        VectGeneric res;
        for (uint64_t i = 0; i < Size; i++) {
            if (u[i] < Size)
                res[i] = v[u[i]];
        }
        return res;
    }
 
    void sort() { std::sort(v.begin(), v.end()); }
 
    bool is_sorted() const {
        for (uint64_t i = 1; i < Size; i++)
            if (v[i - 1] < v[i])
                return false;
        return true;
    }
 
    static VectGeneric random() {
        static std::random_device rd;
        static std::mt19937 g(rd());
 
        VectGeneric<Size, Expo> res = VectGeneric<Size, Expo>(0, 0);
        std::shuffle(res.begin(), res.end(), g);
        return res;
    }
 
    uint64_t first_non_zero(size_t bound = Size) const {
        for (uint64_t i = 0; i < bound; i++)
            if (v[i] != 0)
                return i;
        return Size;
    }
    uint64_t first_zero(size_t bound = Size) const {
        for (uint64_t i = 0; i < bound; i++)
            if (v[i] == 0)
                return i;
        return Size;
    }
    uint64_t last_non_zero(size_t bound = Size) const {
        for (int64_t i = bound - 1; i >= 0; i--)
            if (v[i] != 0)
                return i;
        return Size;
    }
    uint64_t last_zero(size_t bound = Size) const {
        for (int64_t i = bound - 1; i >= 0; i--)
            if (v[i] == 0)
                return i;
        return Size;
    }
 
    bool is_permutation(const size_t k = Size) const {
        auto temp = v;
        std::sort(temp.begin(), temp.end());
        for (uint64_t i = 0; i < Size; i++)
            if (temp[i] != i)
                return false;
        for (uint64_t i = k; i < Size; i++)
            if (v[i] != i)
                return false;
        return true;
    }
 
    uint64_t horiz_sum() const noexcept {
        Expo res = 0;
        for (uint64_t i = 0; i < Size; i++)
            res += v[i];
        return res;
    }
 
    VectGeneric partial_sums() const noexcept {
        auto res = *this;
        for (uint64_t i = 1; i < Size; i++)
            res[i] += res[i - 1];
        return res;
    }
 
    void partial_sums_inplace() {
        for (uint64_t i = 1; i < Size; i++)
            v[i] += v[i - 1];
    }
 
    Expo horiz_max() const {
        Expo res = v[0];
        for (uint64_t i = 1; i < Size; i++)
            res = std::max(res, v[i]);
        return res;
    }
 
    void partial_max_inplace() {
        for (uint64_t i = 1; i < Size; i++)
            v[i] = std::max(v[i], v[i - 1]);
    }
 
    Expo horiz_min() const {
        Expo res = v[0];
        for (uint64_t i = 1; i < Size; i++)
            res = std::min(res, v[i]);
        return res;
    }
 
    void partial_min_inplace() {
        for (uint64_t i = 1; i < Size; i++)
            v[i] = std::min(v[i], v[i - 1]);
    }
 
    VectGeneric eval() const {
        VectGeneric res{};
        for (size_t i = 0; i < Size; i++)
            if (v[i] < Size)
                res[v[i]]++;
        return res;
    }
};
 
static_assert(std::is_trivial<VectGeneric<12>>(),
              "VectGeneric is not a trivial class !");
 
}  // namespace HPCombi
 
namespace std {
 
template <size_t Size, typename Expo>
std::ostream &operator<<(std::ostream &stream,
                         const HPCombi::VectGeneric<Size, Expo> &v) {
    stream << "{" << std::setw(2) << unsigned(v[0]);
    for (unsigned i = 1; i < Size; ++i)
        stream << "," << std::setw(2) << unsigned(v[i]);
    stream << "}";
    return stream;
}

template <size_t Size, typename Expo>
struct hash<HPCombi::VectGeneric<Size, Expo>> {
    size_t operator()(const HPCombi::VectGeneric<Size, Expo> &ar) const {
        size_t h = 0;
        for (size_t i = 0; i < Size; i++)
            h = hash<Expo>()(ar[i]) + (h << 6) + (h << 16) - h;
        return h;
    }
};
 
}  // namespace std
 
#endif  // HPCOMBI_VECT_GENERIC_HPP_