std::chrono::operator+, std::chrono::operator- (std::chrono::year_month)

 

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

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)
Dynamic memory management
Error handling
Program utilities
Variadic functions
Library feature-test macros
Date and time
Function objects
initializer_list (C++11)
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>=
Comparisons (C++20)
strong_order weak_order partial_order strong_equal weak_equal	strong_ordering weak_ordering partial_ordering strong_equality weak_equality	is_eqis_neqis_ltis_lteqis_gtis_gteq
common_comparison_category
Common vocabulary types
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
Swap, forward and move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
Elementary string conversions
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
Type operations
declval (C++11)
as_const (C++17)
launder (C++17)

 

Date and time utilities

duration (C++11) time_point (C++11) time_of_day (C++20)	clock_time_conversion (C++20) clock_cast (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) link (C++20) leap (C++20)
C-style date and time

 

std::chrono::year_month

Member functions

year_month::year_month

year_month::yearyear_month::month

year_month::operator+=year_month::operator-=

year_month::ok

Nonmember functions

operator==operator!=operator<operator<=operator>operator>=

operator+operator-

operator<<

to_stream

from_stream

 

constexpr std::chrono::year_month operator+(const std::chrono::year_month& ym,                                             const std::chrono::years& dy) noexcept;	(1)	(since C++20)
constexpr std::chrono::year_month operator+(const std::chrono::years& dy,                                             const std::chrono::year_month& ym) noexcept;	(2)	(since C++20)
constexpr std::chrono::year_month operator+(const std::chrono::year_month& ym,                                             const std::chrono::months& dm) noexcept;	(3)	(since C++20)
constexpr std::chrono::year_month operator+(const std::chrono::months& dm,                                             const std::chrono::year_month& ym) noexcept;	(4)	(since C++20)
constexpr std::chrono::year_month operator-(const std::chrono::year_month& ym,                                             const std::chrono::years& dy) noexcept;	(5)	(since C++20)
constexpr std::chrono::year_month operator-(const std::chrono::year_month& ym,                                             const std::chrono::months& dm) noexcept;	(6)	(since C++20)
constexpr std::chrono::months operator-(const std::chrono::year_month& ym1,                                         const std::chrono::year_month& ym2) noexcept;	(7)	(since C++20)

1-2) Adds dy.count() years to ym.

3-4) Adds dm.count() months to ym.

5) Subtracts dy.count() years from ym.

6) Subtracts dm.count() months from ym.

7) Returns the difference in months between the two time points represented by ym1 and ym2.

Return value

1-2) std::chrono::year_month(ym.year() + dy, ym.month())

3-4) A year_month value z such that z - ym == dm and z.ok() == true.

5) ym + -dy

5) ym + -dm

7) ym1.year() - ym2.year() + std::chrono::months(int(unsigned(ym1.month())) - int(unsigned(ym2.month())))

Notes

The result of subtracting two year_month values is a duration of type std::chrono::months. This duration unit represents the length of the average Gregorian month (30.436875 days), and the resulting duration bears no relationship to the actual number of days in the time period at issue. For example, the result of 2017y/3 - 2017y/2 is std::chrono::months(1), even though February 2017 only contains 28 days.

Durations that are convertible to std::chrono::months, but not std::chrono::years, can be directly added to or subtracted from a year_month. Durations convertible to std::chrono::years cannot because such durations are also convertible to std::chrono::months, resulting in an ambiguity:

using namespace std::chrono;
 
using decades = duration<int, std::ratio_multiply<std::ratio<10>, years::period>>;
using kilomonths = duration<int, std::ratio_multiply<std::kilo, months::period>>;
 
auto ym = 2001y/April;
ym = ym + decades{1}; // error, ambiguous
ym = ym + kilomonths{1}; // OK

See also

operator+=operator-=

modifies the year_month by some number of months or years (public member function)