std::chrono::round(std::chrono::time_point)

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Utilities library

Language support Type support (basic types, RTTI, type traits) Library feature-test macros (C++20) Dynamic memory management Program utilities Error handling Coroutine support (C++20) Variadic functions launder (C++17) initializer_list (C++11) source_location (C++20) Three-way comparison (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20) is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

General utilities Date and time Function objects Formatting library (C++20) bitset hash (C++11) integer_sequence (C++14) Relational operators (deprecated in C++20) rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_not_equalcmp_lesscmp_greatercmp_less_thancmp_greater_than (C++20)(C++20)(C++20)(C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) forward (C++11) move (C++11) move_if_noexcept (C++11) as_const (C++17) Common vocabulary types pair tuple (C++11) apply (C++17) make_from_tuple (C++17) optional (C++17) any (C++17) variant (C++17) Elementary string conversions to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

Date and time utilities

duration (C++11) time_point (C++11)	clock_time_conversion (C++20) clock_cast (C++20)
Time of day
hh_mm_ss (C++20)	is_amis_pmmake12make24 (C++20)(C++20)(C++20)(C++20)
Clocks
system_clock (C++11) steady_clock (C++11) high_resolution_clock (C++11) is_clock (C++20)	utc_clock (C++20) tai_clock (C++20) gps_clock (C++20) file_clock (C++20) local_t (C++20)
Calendars
day (C++20) month (C++20) year (C++20) weekday (C++20) operator/ (C++20) year_month_day (C++20) year_month_day_last (C++20) year_month_weekday (C++20) year_month_weekday_last (C++20)	weekday_indexed (C++20) weekday_last (C++20) month_day (C++20) month_day_last (C++20) month_weekday (C++20) month_weekday_last (C++20) year_month (C++20)
Time zones
tzdb (C++20) tzdb_list (C++20) get_tzdbget_tzdb_listreload_tzdbremote_version (C++20)(C++20)(C++20)(C++20)	time_zone (C++20) locate_zone (C++20) current_zone (C++20) zoned_time (C++20) time_zone_link (C++20) leap_second (C++20)
C-style date and time

 

std::chrono::time_point

Member functions

time_point::time_point

time_point::time_since_epoch

time_point::operator+time_point::operator-

time_point::operator++time_point::operator-- (C++20)(C++20)

time_point::min

time_point::max

Non-member functions

operator+operator-

operator==operator!=operator<operator<=operator>operator>=operator<=> (until C++20)(C++20)

time_point_cast

floor (C++17)

ceil (C++17)

round (C++17)

Helper classes

common_type

 

Defined in header <chrono>
template <class ToDuration, class Clock, class Duration> constexpr time_point<Clock, ToDuration> round(const time_point<Clock, Duration>& tp);		(since C++17)

Returns the nearest time point to tp representable in ToDuration, rounding to even in halfway cases.

The function does not participate in the overload resolution unless ToDuration is an specialization of std::chrono::duration and std::chrono::treat_as_floating_point<typename ToDuration::rep>::value is false.

Parameters

tp

-

time point to round to nearest

Return value

d rounded to nearest time point using duration of type ToDuration, rounding to even in halfway cases.

Possible implementation

template <class T> struct is_duration : std::false_type {}; template <class Rep, class Period> struct is_duration< std::chrono::duration<Rep, Period>> : std::true_type {};   template <class To, class Clock, class FromDuration, class = std::enable_if_t<is_duration<To>{} && !std::chrono::treat_as_floating_point<typename To::rep>{}>> constexpr std::chrono::time_point<Clock, To> round( const std::chrono::time_point<Clock, FromDuration>& tp) { return std::chrono::time_point<Clock, To>{ std::chrono::round<To>(tp.time_since_epoch())}; }

Example

Run this code

#include <iostream>
#include <chrono>
#include <string>
 
template <typename TimePoint>
std::string to_string(const TimePoint& time_point)
{
    return std::to_string(time_point.time_since_epoch().count());
}
 
int main()
{
    using namespace std::literals::chrono_literals;
    using Sec = std::chrono::seconds;
 
    std::cout << "Time point\t" "Cast\t" "Floor\t" "Round\t" "Ceil\n";
    std::cout << "(ms)\t\t"     "(s)\t"  "(s)\t"   "(s)\t"   "(s)\n";
    for (const auto value_ms: {5432ms, 5678ms}) {
        std::chrono::time_point<std::chrono::system_clock, std::chrono::milliseconds>
            time_point_ms(value_ms);
 
        std::cout
            << to_string(time_point_ms) << "\t\t"
            << to_string(std::chrono::time_point_cast<Sec>(time_point_ms)) << "\t"
            << to_string(std::chrono::floor          <Sec>(time_point_ms)) << "\t"
            << to_string(std::chrono::round          <Sec>(time_point_ms)) << "\t"
            << to_string(std::chrono::ceil           <Sec>(time_point_ms)) << "\n";
    }
}

Output:

Time point	Cast	Floor	Round	Ceil
(ms)		(s)	(s)	(s)	(s)
5432		5	5	5	6
5678		5	5	6	6

See also

time_point_cast	converts a time point to another time point on the same clock, with a different duration (function template)
ceil(std::chrono::time_point) (C++17)	converts a time_point to another, rounding up (function template)
floor(std::chrono::time_point) (C++17)	converts a time_point to another, rounding down (function template)
round(std::chrono::duration) (C++17)	converts a duration to another, rounding to nearest, ties to even (function template)
roundroundfroundllroundlroundflroundlllroundllroundfllroundl (C++11)(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)	nearest integer, rounding away from zero in halfway cases (function)