etl/docs/chrono/time_point.md
John Wellbelove afa17c5042 Squashed commit of the following:
commit c5dc331004b4d9611ab996935bedada203676c71
Author: John Wellbelove <john.wellbelove@etlcpp.com>
Date:   Sat Jul 11 12:32:20 2026 +0100

    Updated release notes

commit 4bf6ed6ce8d79857658d763e368ee56617542b2c
Author: vcoselev <145198867+vcoselev@users.noreply.github.com>
Date:   Sat Jul 11 12:05:39 2026 +0100

    Fix for 1405: etl::exchange doesn't work with unique_ptr (#1477)

    * Separate bit order and endianness in bit_stream.h (#1495)

    * Factor out ranges tests from test_algorithm.cpp to test_algorithm_ranges.cpp (#1497)

    * Fix exchange to use forwarding reference (U&&) and move

    - etl::exchange was using the copy constructor. Changed for etl::move.
    - The assignment to the new object is now done with forward.
    - Added a test with unique_ptr.

    ---------

    Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>
    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit 2ed9019df04d470530c41c1f27d35adc30b9a32d
Author: Moritz Pflanzer <moritz@pflanzer.eu>
Date:   Fri Jul 10 11:42:32 2026 +0200

    Update operator[] docs for map class (#1499)

    * Separate bit order and endianness in bit_stream.h (#1495)

    * Update operator[] docs for map class

    No const variant is implemented for the operator[].

    ---------

    Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>

commit 423e18d96dc645f1c733cb0d8ae6b675b9eb7e83
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Fri Jul 10 11:14:08 2026 +0200

    Factor out ranges tests from test_algorithm.cpp to test_algorithm_ranges.cpp (#1497)

commit 338bfdbb1f4df3c5c08a68a9038f13b8dae1c28b
Author: John Wellbelove <jwellbelove@users.noreply.github.com>
Date:   Fri Jul 10 10:12:04 2026 +0100

    Add coverage report to docs (#1498)

    * Updated release notes

    * Added link to coverage report

    ---------

    Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>

commit 269025424f4c6f61cebac090f4df82985fb3b239
Merge: c004cc9d faa4c15b
Author: John Wellbelove <john.wellbelove@etlcpp.com>
Date:   Thu Jul 9 14:18:32 2026 +0100

    Merge branch 'development' of https://github.com/ETLCPP/etl into development

commit c004cc9d508efcf398630758a47aae95b37a7eb8
Author: John Wellbelove <john.wellbelove@etlcpp.com>
Date:   Thu Jul 9 10:06:17 2026 +0100

    Updated release notes

commit faa4c15b49c8ad15475c83ae23e00f5a46f803ca
Author: John Wellbelove <john.wellbelove@etlcpp.com>
Date:   Thu Jul 9 10:06:17 2026 +0100

    Updated release notes

commit 1523e63e35a15cfd1fa72d230a3c79efa7b9c3e0
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Wed Jul 8 20:48:33 2026 +0200

    Support non-assignable alternatives in variant (#1496)

commit 878a0ba5a28f6b0dcae9f472a6a6a1f107de0a74
Author: John Wellbelove <john.wellbelove@etlcpp.com>
Date:   Wed Jul 8 11:07:01 2026 +0100

    Updated version and release notes

commit 5287fe4b3b9f58330881d2a62abf6ce8e1159b8d
Author: John Wellbelove <jwellbelove@users.noreply.github.com>
Date:   Wed Jul 8 09:06:50 2026 +0100

    Allow etl::vector to store pointers to functions and member functions (#1492)

    * Refactored vector.h

    Deleted ivectorpointer.h

    * Minor changes

    * Fixed code incompatible with C++03

    * Clang-format changes

    * Removed redundant double-qualified name

    * Fixed is_is_object_pointer_v to is_object_pointer_v

    * Added new test files to meson.build

    * Added overflow checks to vector_ext copy and move constructors and assignments

    Added assert throw tests.

    * Added diagnostic pushes to eliminate GCC warning false positives

    * Changed the GCC C++23 Github action to use GCC14

    * Applied clang-format

    * Added guard to pop_heap

    * Added guard to adjust_heap

    * Attempt to fix GCC diagnostic

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * clang-format

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Missing newline at end of file

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    Re-enable ranges algorithm tests

    * Attempt to fix GCC diagnostic

    * clang-format

    * Changed gcc --version to gcc-14 --version

    ---------

    Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
    Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>

commit 40dddd7f9601985ae7350e60a404af9028bc9fe9
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 23:41:17 2026 +0200

    Add optional etl_profile label_flag for Bazel profile injection (#1491)

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit 84fca4cd62f72c382c062376ca934803116a20d5
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 21:45:47 2026 +0200

    Add missing memory functions, according the standard (#1490)

    Adding:

    - etl::align
    - etl::assume_aligned
    - etl::is_sufficiently_aligned
    - etl::launder
    - etl::pointer_traits
    - etl::start_lifetime_as

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit dca6653b3759b2cdc79307fec7425589feea478d
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 21:00:09 2026 +0200

    Add missing interfaces to etl::chrono (#1489)

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit c52b2ac7b1f675e6b1d34052239423b7f3634033
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 18:06:05 2026 +0200

    Fix etl::mem_cast cross-size copy constructor and assignment (#1488)

    The templated cross-size copy constructor and assignment operator were
    broken in two ways:

    - They accessed other.buffer / rhs.buffer, which is private in a
      different mem_cast instantiation, so the cross-size overloads failed
      to compile whenever they were actually instantiated.
    - They copied Size_ (the destination size) bytes from a source buffer
      that is only Other_Size bytes large, reading past the end of the
      source when the destination was larger.

    Use the public data() accessor and copy Other_Size bytes. The existing
    static_assert(Size >= Other_Size) guarantees the destination is big
    enough.

    Add test_mem_cast_copy_and_assign_from_smaller regression test.

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit 165674cb23dda1fd4f7e5a1182f49554a796bfe8
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 16:41:50 2026 +0200

    Fix etl::pearson::reset() not resetting the first-byte flag (#1487)

    reset() cleared the hash array but left the `first` flag false, so a
    calculator reused after reset() took the XOR update path on its next
    add() instead of the initialisation path. This produced an incorrect
    hash for any pearson object that was reset and reused.

    Reset `first` to true in reset() so a reset calculator behaves like a
    freshly constructed one.

    Add test_pearson_reset regression test.

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit 032ec4cc80f1c0f1baa0383bdbc5f9239b68f268
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 13:40:04 2026 +0200

    Fix etl::bitset single-element from_string shift on empty string (#1486)

    The single-element from_string overloads (char, wchar_t, char16_t,
    char32_t) computed element_type(1) << (string_length - 1U) before the
    copy loop. For an empty string, or when active_bits is 0, string_length
    is 0, so the shift count underflows to SIZE_MAX. Shifting by more than
    the element width is undefined behaviour, which also breaks constexpr
    evaluation.

    Guard the mask with a zero-length check so the shift is only performed
    when string_length > 0. The multi-element from_string overloads were
    already safe.

    Add test_construct_from_empty_string regression test.

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit 98cb365d4c28e7b72f8547b734a03a4068acd3f5
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Tue Jul 7 12:32:56 2026 +0200

    Fix etl::histogram copy/move not preserving start_index (#1485)

    The run-time-offset specialization of etl::histogram stores a start_index
    member used to map keys to bins (accumulator[key - start_index]). Its copy
    constructor, move constructor, copy assignment, and move assignment copied
    only the accumulator and left start_index uninitialized, so a copied or
    moved histogram indexed the wrong bin in operator[]/add(), causing
    out-of-bounds access (undefined behavior).

    All four special member functions now also copy start_index. The
    compile-time-offset specialization is unaffected, as its start index is a
    template constant rather than a data member.

    Add regression tests covering copy/move construction and assignment.

    Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>

commit 5cd2f28cd54e4019f7be126bcf7394a6a8318eb9
Author: Drew Rife <darife@jlg.com>
Date:   Tue Jul 7 03:14:48 2026 -0400

    Refactor variant::emplace to perfect forward args instead of copy/move construct (#1494)

    * refactor: emplace logic to use do_emplace for in-place construction with forwarded arguments #1493

    * Add test for variant_variadic

    ---------

    Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>

commit a47c0aae81b886259918961d5fcee20faa06fdd0
Author: Roland Reichwein <Roland.Reichwein@bmw.de>
Date:   Mon Jul 6 17:32:26 2026 +0200

    Fix etl::message_timer firing following timers early on unregister (#1484)

    active_list.remove(id, has_expired) adjusts the next timer's delta only
    when has_expired is false. When unregistering an active, non-expired timer,
    unregister_timer() incorrectly passed true, skipping that adjustment, so
    every timer after the removed one in the active list fired early by the
    removed timer's delta.

    Pass false instead, matching the etl::callback_timer family. tick() still
    passes true, since the timer has genuinely expired there. The bug affected
    all four variants: message_timer, message_timer_interrupt,
    message_timer_atomic and message_timer_locked. Existing tests missed it
    because they only ever unregistered the tail timer, where the delta
    adjustment is a no-op.

    Add a regression test that unregisters a non-tail active timer and checks
    the following timer still fires at its original absolute time.
2026-07-11 13:02:42 +01:00

8.3 KiB

title
time_point

{{< callout type="info">}} Header: chrono.h
From: 20.41.0
Similar to: std::chrono::time_point {{< /callout >}}

template <typename TClock, typename TDuration = typename TClock::duration>
class time_point;

Represents a point in time storing a TDuration indicating the time interval from the start of the TClock's epoch.

Member types

using clock    = TClock
using duration = TDuration
using rep      = typename TDuration::rep
using period   = typename TDuration::period

Constructors

ETL_CONSTEXPR 
time_point() 
ETL_NOEXCEPT

Description
Default constructor.


ETL_CONSTEXPR14 
explicit time_point(const duration& dur_) 
ETL_NOEXCEPT

Description
Construct from a duration.


ETL_CONSTEXPR14 
time_point(const time_point& rhs) 
ETL_NOEXCEPT

Description
Copy constructor.


template <typename TDuration2>
ETL_CONSTEXPR14 
explicit time_point(const time_point<clock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Copy construct from another time_point with a different duration type.

Assignment

ETL_CONSTEXPR14 
time_point& operator =(const time_point& rhs) 
ETL_NOEXCEPT

Description
Assignment operator.

Access

ETL_NODISCARD
ETL_CONSTEXPR14 duration time_since_epoch() const 
ETL_NOEXCEPT

Return
A duration representing the amount of time between this and the clock's epoch.

Member arithmetic operators

ETL_CONSTEXPR14 time_point& operator +=(const duration& rhs) 
ETL_NOEXCEPT

Description
Adds a duration.


ETL_CONSTEXPR14 time_point& operator -=(const duration& rhs) 
ETL_NOEXCEPT

Description
Subtracts a duration.

Increment/decrement

ETL_CONSTEXPR14 time_point& operator ++() 
ETL_NOEXCEPT

Description
Pre-increments the stored duration by one tick.


ETL_CONSTEXPR14 time_point operator ++(int) 
ETL_NOEXCEPT

Description
Post-increments the stored duration by one tick.


ETL_CONSTEXPR14 time_point& operator --() 
ETL_NOEXCEPT

Description
Pre-decrements the stored duration by one tick.


ETL_CONSTEXPR14 time_point operator --(int) 
ETL_NOEXCEPT

Description
Post-decrements the stored duration by one tick.

Constants

ETL_NODISCARD
static ETL_CONSTEXPR14 time_point min() 
ETL_NOEXCEPT

Return
A time_point with the smallest possible duration.


ETL_NODISCARD
static ETL_CONSTEXPR14 time_point max() 
ETL_NOEXCEPT

Return
A time_point with the largest possible duration.

Rounding

template <typename TToDuration, typename TClock, typename TDuration>
ETL_NODISCARD
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, TToDuration>
  floor(const etl::chrono::time_point<TClock, TDuration>& tp) 
ETL_NOEXCEPT

Description
Rounds down a duration to the nearest lower precision.


template <typename TToDuration, typename TClock, typename TDuration>
ETL_NODISCARD
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, TToDuration>
  ceil(const etl::chrono::time_point<TClock, TDuration>& tp) 
ETL_NOEXCEPT

Description
Rounds up a duration to the nearest higher precision.


template <typename TToDuration, typename TClock, typename TDuration>
ETL_NODISCARD
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, TToDuration>
  round(const etl::chrono::time_point<TClock, TDuration>& tp) 
ETL_NOEXCEPT

Description
Rounds a duration to the nearest precision. If the duration is exactly halfway, it rounds away from zero.

Casting

template <typename TToDuration, typename TClock, typename TDuration>
ETL_NODISCARD
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, TToDuration>
  time_point_cast(const etl::chrono::time_point<TClock, TDuration>& tp) 
ETL_NOEXCEPT

Comparison

ETL_NODISCARD
ETL_CONSTEXPR14 int compare(const time_point& other) const 
ETL_NOEXCEPT

Description
Compare day with another.
If time_point < other, returns -1
else if time_point > other, returns 1
else returns 0

Non-member mathematical operators

template <typename TClock, typename TDuration1, typename TRep2, typename TPeriod2>
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, typename etl::common_type<TDuration1, etl::chrono::duration<TRep2, TPeriod2> >::type>
  operator +(const time_point<TClock, TDuration1>& lhs, 
             const etl::chrono::duration<TRep2, TPeriod2>& rhs) 
ETL_NOEXCEPT

Description
Adds a duration to a time_point.
Return
A time_point whose duration is the common type of the two.


template <typename TRep1, typename TPeriod1, typename TClock, typename TDuration2>
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, typename etl::common_type<etl::chrono::duration<TRep1, TPeriod1>, TDuration2>::type>
  operator +(const etl::chrono::duration<TRep1, TPeriod1>& lhs, 
             const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Adds a duration to a time_point.
Return
A time_point whose duration is the common type of the two.


template <typename TClock, typename TDuration1, typename TRep2, typename TPeriod2>
ETL_CONSTEXPR14 
etl::chrono::time_point<TClock, typename etl::common_type<TDuration1, etl::chrono::duration<TRep2, TPeriod2> >::type>
  operator -(const time_point<TClock, TDuration1>& lhs, 
             const etl::chrono::duration<TRep2, TPeriod2>& rhs) 
ETL_NOEXCEPT

Description
Subtracts a duration from a time_point.
Return
A time_point whose duration is the common type of the two.


template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
typename etl::common_type<TDuration1, TDuration2>::type 
  operator -(const time_point<TClock, TDuration1>& lhs, 
             const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Subtracts one time_point from another.
Return
The duration between them as the common type of the two durations.

Non-member comparison operators

template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
bool operator ==(const time_point<TClock, TDuration1>& lhs, 
                 const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Equality operator


template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
bool operator !=(const time_point<TClock, TDuration1>& lhs, 
                 const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Inequality operator


template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
bool operator <(const time_point<TClock, TDuration1>& lhs, 
                const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Less-than operator


template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
bool operator <=(const time_point<TClock, TDuration1>& lhs, 
                 const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Less-than-equal operator


template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
bool operator >(const time_point<TClock, TDuration1>& lhs, 
                const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Greater-than operator


template <typename TClock, typename TDuration1, typename TDuration2>
ETL_CONSTEXPR14 
bool operator >=(const time_point<TClock, TDuration1>& lhs,
                 const time_point<TClock, TDuration2>& rhs) 
ETL_NOEXCEPT

Description
Greater-than-equal operator


template <typename TClock, typename TDuration1, typename TDuration2>
[[nodiscard]] constexpr auto operator <=>(const etl::chrono::time_point<TClock, TDuration1>& lhs, 
                                          const etl::chrono::time_point<TClock, TDuration2>& rhs) 
noexcept

Description
Spaceship operator C++20

etl::common_type specialisation

template <typename TClock, typename TDuration1, typename TDuration2>
struct common_type<etl::chrono::time_point<TClock, TDuration1>, 
                   etl::chrono::time_point<TClock, TDuration2>>

Description
Defines type, which is the common type of two etl::chrono::time_point.