25 Time library [time]

25.8 The civil calendar [time.cal]

25.8.5 Class year [time.cal.year]

25.8.5.1 Overview [time.cal.year.overview]

namespace std::chrono {
  class year {
    short y_;                   // exposition only
  public:
    year() = default;
    explicit constexpr year(int y) noexcept;

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

    constexpr year& operator+=(const years& y) noexcept;
    constexpr year& operator-=(const years& y) noexcept;

    constexpr year operator+() const noexcept;
    constexpr year operator-() const noexcept;

    constexpr bool is_leap() const noexcept;

    explicit constexpr operator int() const noexcept;
    constexpr bool ok() const noexcept;

    static constexpr year min() noexcept;
    static constexpr year max() noexcept;
  };
}
1
#
year represents a year in the civil calendar.
It can represent values in the range [min(), max()].
It can be constructed with any int value, which will be subsequently truncated to fit into year's unspecified internal storage.
year is Cpp17EqualityComparable (Table 22) and Cpp17LessThanComparable (Table 23), and participates in basic arithmetic with years objects, which represent a difference between two year objects.
2
#
year is a trivially copyable and standard-layout class type.

25.8.5.2 Member functions [time.cal.year.members]

🔗
explicit constexpr year(int y) noexcept;
1
#
Effects: Constructs an object of type year by initializing y_­ with y.
The value held is unspecified if y is not in the range [-32767, 32767].
🔗
constexpr year& operator++() noexcept;
2
#
Effects: ++y_­.
3
#
Returns: *this.
🔗
constexpr year operator++(int) noexcept;
4
#
Effects: ++(*this).
5
#
Returns: A copy of *this as it existed on entry to this member function.
🔗
constexpr year& operator--() noexcept;
6
#
Effects: --y_­.
7
#
Returns: *this.
🔗
constexpr year operator--(int) noexcept;
8
#
Effects: --(*this).
9
#
Returns: A copy of *this as it existed on entry to this member function.
🔗
constexpr year& operator+=(const years& y) noexcept;
10
#
Effects: *this = *this + y.
11
#
Returns: *this.
🔗
constexpr year& operator-=(const years& y) noexcept;
12
#
Effects: *this = *this - y.
13
#
Returns: *this.
🔗
constexpr year operator+() const noexcept;
14
#
Returns: *this.
🔗
constexpr year year::operator-() const noexcept;
15
#
Returns: year{-y_­}.
🔗
constexpr bool is_leap() const noexcept;
16
#
Returns: y_­ % 4 == 0 && (y_­ % 100 != 0 || y_­ % 400 == 0).
🔗
explicit constexpr operator int() const noexcept;
17
#
Returns: y_­.
🔗
constexpr bool ok() const noexcept;
18
#
Returns: min() <= y_­ && y_­ <= max().
🔗
static constexpr year min() noexcept;
19
#
Returns: year{-32767}.
🔗
static constexpr year max() noexcept;
20
#
Returns: year{32767}.

25.8.5.3 Non-member functions [time.cal.year.nonmembers]

🔗
constexpr bool operator==(const year& x, const year& y) noexcept;
1
#
Returns: int{x} == int{y}.
🔗
constexpr bool operator<(const year& x, const year& y) noexcept;
2
#
Returns: int{x} < int{y}.
🔗
constexpr year operator+(const year& x, const years& y) noexcept;
3
#
Returns: year{int{x} + y.count()}.
🔗
constexpr year operator+(const years& x, const year& y) noexcept;
4
#
Returns: y + x.
🔗
constexpr year operator-(const year& x, const years& y) noexcept;
5
#
Returns: x + -y.
🔗
constexpr years operator-(const year& x, const year& y) noexcept;
6
#
Returns: years{int{x} - int{y}}.
🔗
template<class charT, class traits> basic_ostream<charT, traits>& operator<<(basic_ostream<charT, traits>& os, const year& y);
7
#
Effects: Inserts format(fmt, y) where fmt is "%Y" widened to charT.
If !y.ok(), appends with " is not a valid year".
8
#
Returns: os.
🔗
template<class charT, class traits> basic_ostream<charT, traits>& to_stream(basic_ostream<charT, traits>& os, const charT* fmt, const year& y);
9
#
Effects: Streams y into os using the format specified by the NTCTS fmt.
fmt encoding follows the rules specified in [time.format].
10
#
Returns: os.
🔗
template<class charT, class traits, class Alloc = allocator<charT>> basic_istream<charT, traits>& from_stream(basic_istream<charT, traits>& is, const charT* fmt, year& y, basic_string<charT, traits, Alloc>* abbrev = nullptr, minutes* offset = nullptr);
11
#
Effects: Attempts to parse the input stream is into the year y using the format flags given in the NTCTS fmt as specified in [time.parse].
If the parse fails to decode a valid year, is.setstate(ios_­base​::​failbit) shall be called and y shall not be 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.
12
#
Returns: is.
🔗
constexpr year operator""y(unsigned long long y) noexcept;
13
#
Returns: year{static_­cast<int>(y)}.