histogram_policy.hpp

/*
 * This file is part of libtcspc
 * Copyright 2019-2026 Board of Regents of the University of Wisconsin System
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
 
#include <type_traits>
 
namespace tcspc {

enum class histogram_policy : unsigned {
    default_policy = 0,

    error_on_overflow = 0b00,

    stop_on_overflow = 0b01,

    saturate_on_overflow = 0b10,

    reset_on_overflow = 0b11,

    overflow_mask = 0b11,

    emit_concluding_events = 1 << 2,

    reset_after_scan = 1 << 3,

    clear_every_scan = 1 << 4,

    no_clear_new_bucket = 1 << 5,
};

constexpr auto operator|(histogram_policy lhs, histogram_policy rhs) noexcept
    -> histogram_policy {
    using U = std::underlying_type_t<histogram_policy>;
    return static_cast<histogram_policy>(static_cast<U>(lhs) |
                                         static_cast<U>(rhs));
}

constexpr auto operator&(histogram_policy lhs, histogram_policy rhs) noexcept
    -> histogram_policy {
    using U = std::underlying_type_t<histogram_policy>;
    return static_cast<histogram_policy>(static_cast<U>(lhs) &
                                         static_cast<U>(rhs));
}

constexpr auto operator~(histogram_policy hp) noexcept -> histogram_policy {
    using U = std::underlying_type_t<histogram_policy>;
    return static_cast<histogram_policy>(~static_cast<U>(hp));
}

constexpr auto operator|=(histogram_policy &lhs, histogram_policy rhs) noexcept
    -> histogram_policy & {
    return lhs = lhs | rhs;
}

constexpr auto operator&=(histogram_policy &lhs, histogram_policy rhs) noexcept
    -> histogram_policy & {
    return lhs = lhs & rhs;
}
 
} // namespace tcspc