27 Time library [time]

27.8 The civil calendar [time.cal]

27.8.4 Class month [time.cal.month]

27.8.4.1 Overview [time.cal.month.overview]

namespace std::chrono {
  class month {
    unsigned char m_;           // exposition only
  public:
    month() = default;
    constexpr explicit month(unsigned m) noexcept;

    constexpr month& operator++()    noexcept;
    constexpr month  operator++(int) noexcept;
    constexpr month& operator--()    noexcept;
    constexpr month  operator--(int) noexcept;

    constexpr month& operator+=(const months& m) noexcept;
    constexpr month& operator-=(const months& m) noexcept;

    constexpr explicit operator unsigned() const noexcept;
    constexpr bool ok() const noexcept;
  };
}
1
#
month represents a month of a year.
It normally holds values in the range 1 to 12, but may hold non-negative values outside this range.
It can be constructed with any unsigned value, which will be subsequently truncated to fit into month's unspecified internal storage.
month meets the Cpp17EqualityComparable (Table 25) and Cpp17LessThanComparable (Table 26) requirements, and participates in basic arithmetic with months objects, which represent a difference between two month objects.
2
#
month is a trivially copyable and standard-layout class type.

27.8.4.2 Member functions [time.cal.month.members]

🔗
constexpr explicit month(unsigned m) noexcept;
1
#
Effects: Initializes m_­ with m.
The value held is unspecified if m is not in the range [0, 255].
🔗
constexpr month& operator++() noexcept;
2
#
Effects: *this += months{1}.
3
#
Returns: *this.
🔗
constexpr month operator++(int) noexcept;
4
#
Effects: ++(*this).
5
#
Returns: A copy of *this as it existed on entry to this member function.
🔗
constexpr month& operator--() noexcept;
6
#
Effects: *this -= months{1}.
7
#
Returns: *this.
🔗
constexpr month operator--(int) noexcept;
8
#
Effects: --(*this).
9
#
Returns: A copy of *this as it existed on entry to this member function.
🔗
constexpr month& operator+=(const months& m) noexcept;
10
#
Effects: *this = *this + m.
11
#
Returns: *this.
🔗
constexpr month& operator-=(const months& m) noexcept;
12
#
Effects: *this = *this - m.
13
#
Returns: *this.
🔗
constexpr explicit operator unsigned() const noexcept;
14
#
Returns: m_­.
🔗
constexpr bool ok() const noexcept;
15
#
Returns: 1 <= m_­ && m_­ <= 12.

27.8.4.3 Non-member functions [time.cal.month.nonmembers]

🔗
constexpr bool operator==(const month& x, const month& y) noexcept;
1
#
Returns: unsigned{x} == unsigned{y}.
🔗
constexpr strong_ordering operator<=>(const month& x, const month& y) noexcept;
2
#
Returns: unsigned{x} <=> unsigned{y}.
🔗
constexpr month operator+(const month& x, const months& y) noexcept;
3
#
Returns: 
month{modulo(static_cast<long long>(unsigned{x}) + (y.count() - 1), 12) + 1}
where modulo(n, 12) computes the remainder of n divided by 12 using Euclidean division.
[Note
:
Given a divisor of 12, Euclidean division truncates towards negative infinity and always produces a remainder in the range of [0, 11].
Assuming no overflow in the signed summation, this operation results in a month holding a value in the range [1, 12] even if !x.ok().
— end note
]
[Example
:
February + months{11} == January.
— end example
]
🔗
constexpr month operator+(const months& x, const month& y) noexcept;
4
#
Returns: y + x.
🔗
constexpr month operator-(const month& x, const months& y) noexcept;
5
#
Returns: x + -y.
🔗
constexpr months operator-(const month& x, const month& y) noexcept;
6
#
Returns: If x.ok() == true and y.ok() == true, returns a value m in the range [months{0}, months{11}] satisfying y + m == x.
Otherwise the value returned is unspecified.
[Example
:
January - February == months{11}.
— end example
]
🔗
template<class charT, class traits> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& os, const month& m);
7
#
Effects: Equivalent to: 
return os << (m.ok() ?
  format(os.getloc(), STATICALLY-WIDEN<charT>("{:%b}"), m) :
  format(os.getloc(), STATICALLY-WIDEN<charT>("{} is not a valid month"),
         static_cast<unsigned>(m)));
🔗
template<class charT, class traits, class Alloc = allocator<charT>> basic_istream<charT, traits>& from_stream(basic_istream<charT, traits>& is, const charT* fmt, month& m, basic_string<charT, traits, Alloc>* abbrev = nullptr, minutes* offset = nullptr);
8
#
Effects: Attempts to parse the input stream is into the month m using the format flags given in the NTCTS fmt as specified in [time.parse].
If the parse fails to decode a valid month, is.setstate(ios_­base​::​failbit) is called and m is not modified.
If %Z is used and successfully parsed, that value will be assigned to *abbrev if abbrev is non-null.
If %z (or a modified variant) is used and successfully parsed, that value will be assigned to *offset if offset is non-null.
9
#
Returns: is.