ticks.h

Go to the documentation of this file.

// Copyright (c) 2026 Tinverse LLC. All rights reserved.
// SPDX-License-Identifier: LicenseRef-Tinverse-Commercial
 
 
#pragma once
 
#include <chrono>
#include <cstdint>
#include <ratio>
#include <type_traits>
 
#ifndef TSM_TICK_REP
#define TSM_TICK_REP std::uint32_t
#endif
 
#ifndef TSM_TICK_PERIOD
#define TSM_TICK_PERIOD std::ratio<1>
#endif
 
namespace tsm {
 
using tick_rep = TSM_TICK_REP;
 
using tick_period = TSM_TICK_PERIOD;
 
static_assert(std::is_integral_v<tick_rep> && std::is_unsigned_v<tick_rep>,
              "tsm: TSM_TICK_REP must name an unsigned integral type");
static_assert(tick_period::num > 0 && tick_period::den > 0,
              "tsm: TSM_TICK_PERIOD must name a positive std::ratio");
 
using tick_duration = std::chrono::duration<tick_rep, tick_period>;
 
struct tick_count
{
    using rep = tick_rep;
    using period = tick_period;
    using value_type = tick_duration;
 
    tick_duration value{};
 
    constexpr tick_count() noexcept = default;
 
    explicit constexpr tick_count(tick_duration duration) noexcept
      : value(duration)
    {
    }
 
    explicit constexpr tick_count(tick_rep count) noexcept
      : value(tick_duration{ count })
    {
    }
 
    [[nodiscard]] constexpr tick_rep count() const noexcept
    {
        return value.count();
    }
};
 
[[nodiscard]] consteval tick_count operator""_ticks(unsigned long long value)
{
    return tick_count{ tick_duration{ static_cast<tick_rep>(value) } };
}
 
[[nodiscard]] constexpr tick_count
ticks(tick_rep value) noexcept
{
    return tick_count{ value };
}
 
template<typename Rep, typename Period>
[[nodiscard]] constexpr tick_count
ticks(std::chrono::duration<Rep, Period> value) noexcept
{
    return tick_count{ std::chrono::duration_cast<tick_duration>(value) };
}
 
} // namespace tsm