mtcore::calendars::CalDateTime< Calendar > Struct Template Reference

#include <core.hpp>

Inheritance diagram for mtcore::calendars::CalDateTime< Calendar >:

Collaboration diagram for mtcore::calendars::CalDateTime< Calendar >:

Public Types
using	CalendarSystem = Calendar

Public Member Functions
constexpr Segments	time_segments () const
constexpr	operator CalDate< Calendar > () const noexcept
constexpr bool	is_valid () const
	Checks that a date is valid.
constexpr CalDateTime	nearest_valid () const
	Moves the date to the nearest valid date.
template<typename Other>
constexpr	operator CalDateTime< Other > () const noexcept
template<IsTimeCalendarSystem Other>
constexpr std::partial_ordering	operator<=> (const CalDateTime< Other > &o) const
template<IsDayCalendarSystem Other>
constexpr std::partial_ordering	operator<=> (const CalDateTime< Other > &o) const
template<typename Other>
constexpr auto	operator== (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator!= (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator<= (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator>= (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator< (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator> (const CalDateTime< Other > &o) const -> bool
constexpr DayOfWeek	day_of_week () const
	Gets the day of week for a date.
constexpr CalDateTime	add_days (const i32 days) const
	Adds n days to a date.
constexpr CalDateTime	sub_days (const i32 days) const
	Subtracts n days from a date.
template<typename Other>
constexpr i32	day_difference (const CalDateTime< Other > &other) const
	Difference between two dates in days.
constexpr CalDateTime	nth_week_day (const i32 n, const DayOfWeek k) const
	Gets the nth day of week.
constexpr CalDateTime	day_of_week_before (const DayOfWeek k) const
	Gets the day of week before current date.
constexpr CalDateTime	day_of_week_after (const DayOfWeek k) const
	Gets the day of week after the current date.
constexpr CalDateTime	day_of_week_nearest (const DayOfWeek k) const
	Gets the day of week nearest to the current date.
constexpr CalDateTime	day_of_week_on_or_before (const DayOfWeek k) const
	Gets the day of week on or before the current date.
constexpr CalDateTime	day_of_week_on_or_after (const DayOfWeek k) const
	Gets the day of week on or after the current date.
constexpr CalDateTime	first_week_day (const DayOfWeek k) const
	Gets the first week day in a month (assuming current date is the start of the month)
constexpr CalDateTime	last_week_day (const DayOfWeek k) const
	Gets the last week day in a month (assuming current date is the end of the month)
template<typename Other>
auto	positions_in_range (Allocator &alloc, const CalDateTime< Other > &end, i32 pthMoment, i32 cDayCycle, i32 delta) const -> Result< ArrayList< CalDateTime >, AllocationError >
	Return the cyclic positions in the range of the current date to the end date (exclusive) Used to collect all occurrences of events (e.g.
i32	day_of_m_cycle (i32 m, i32 offset) const
	Gets which day the current date occurs in an m-length ("month") cycle.
auto	kth_day_of_m_cycle_on_or_before (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs on or before the current date.
auto	kth_day_of_m_cycle_before (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs before the current date.
auto	kth_day_of_m_cycle_on_or_after (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs on or after the current date.
auto	kth_day_of_m_cycle_after (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs after the current date.
auto	kth_day_of_m_cycle_nearest (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs nearest the current date.
constexpr bool	is_valid () const
	Checks that a date is valid.
constexpr CalDateTime	nearest_valid () const
	Moves the date to the nearest valid date.
constexpr Segments	time_segments () const
constexpr	operator CalDate< Fixed > () const noexcept
template<typename Other>
constexpr	operator CalDateTime< Other > () const noexcept
template<IsDayCalendarSystem Other>
constexpr std::partial_ordering	operator<=> (const CalDateTime< Other > &o) const
template<IsTimeCalendarSystem Other>
constexpr std::partial_ordering	operator<=> (const CalDateTime< Other > &o) const
template<typename Other>
constexpr auto	operator== (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator!= (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator<= (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator>= (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator< (const CalDateTime< Other > &o) const -> bool
template<typename Other>
constexpr auto	operator> (const CalDateTime< Other > &o) const -> bool
constexpr DayOfWeek	day_of_week () const
	Gets the day of week for a date.
constexpr CalDateTime	add_days (const i32 days) const
	Adds n days to a date.
constexpr CalDateTime	sub_days (const i32 days) const
	Subtracts n days from a date.
template<typename Other>
constexpr i32	day_difference (const CalDateTime< Other > &other) const
	Difference between two dates in days.
constexpr CalDateTime	nth_week_day (const i32 n, const DayOfWeek k) const
	Gets the nth day of week.
constexpr CalDateTime	day_of_week_before (const DayOfWeek k) const
	Gets the day of week before current date.
constexpr CalDateTime	day_of_week_after (const DayOfWeek k) const
	Gets the day of week after the current date.
constexpr CalDateTime	day_of_week_nearest (const DayOfWeek k) const
	Gets the day of week nearest to the current date.
constexpr CalDateTime	day_of_week_on_or_before (const DayOfWeek k) const
	Gets the day of week on or before the current date.
constexpr CalDateTime	day_of_week_on_or_after (const DayOfWeek k) const
	Gets the day of week on or after the current date.
constexpr CalDateTime	first_week_day (const DayOfWeek k) const
	Gets the first week day in a month (assuming current date is the start of the month)
constexpr CalDateTime	last_week_day (const DayOfWeek k) const
	Gets the last week day in a month (assuming current date is the end of the month)
template<typename Other>
auto	positions_in_range (Allocator &alloc, const CalDateTime< Other > &end, i32 pthMoment, i32 cDayCycle, i32 delta) const -> Result< ArrayList< CalDateTime >, AllocationError >
	Return the cyclic positions in the range of the current date to the end date (exclusive) Used to collect all occurrences of events (e.g.
i32	day_of_m_cycle (i32 m, i32 offset) const
	Gets which day the current date occurs in an m-length ("month") cycle.
auto	kth_day_of_m_cycle_on_or_before (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs on or before the current date.
auto	kth_day_of_m_cycle_before (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs before the current date.
auto	kth_day_of_m_cycle_on_or_after (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs on or after the current date.
auto	kth_day_of_m_cycle_after (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs after the current date.
auto	kth_day_of_m_cycle_nearest (i32 k, i32 m, i32 offset) const noexcept -> CalDateTime
	Finds the kth day of the m-cycle that occurs nearest the current date.

Public Attributes
Calendar	cal
Segments	time = {}
Calendar	dateTime

Detailed Description

template<IsDayCalendarSystem Calendar>
struct mtcore::calendars::CalDateTime< Calendar >

Definition at line 372 of file calendars/mtcore_calendars/core.hpp.

Member Typedef Documentation

CalendarSystem

template<IsDayCalendarSystem Calendar>

using mtcore::calendars::CalDateTime< Calendar >::CalendarSystem = Calendar

Definition at line 373 of file calendars/mtcore_calendars/core.hpp.

Member Function Documentation

add_days() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::add_days ( const i32 days ) const

inlinenodiscardconstexpr

Adds n days to a date.

Definition at line 478 of file calendars/mtcore_calendars/core.hpp.

                                                                       {
      return {Calendar::from_fixed(cal.to_fixed().add_days(days))};
    }

add_days() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::add_days ( const i32 days ) const

inlinenodiscardconstexpr

Adds n days to a date.

Definition at line 728 of file calendars/mtcore_calendars/core.hpp.

                                                                       {
      return {Calendar::from_moment(dateTime.to_moment().add_days(days))};
    }

day_difference() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

i32 mtcore::calendars::CalDateTime< Calendar >::day_difference ( const CalDateTime< Other > & other ) const

inlinenodiscardconstexpr

Difference between two dates in days.

Definition at line 489 of file calendars/mtcore_calendars/core.hpp.

                                                                                      {
      const auto om = static_cast<CalDateTime<Calendar>>(other);
      return cal.to_fixed().day_difference(om.cal.to_fixed());
    }

day_difference() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

i32 mtcore::calendars::CalDateTime< Calendar >::day_difference ( const CalDateTime< Other > & other ) const

inlinenodiscardconstexpr

Difference between two dates in days.

Definition at line 739 of file calendars/mtcore_calendars/core.hpp.

                                                                                      {
      const auto om = static_cast<CalDateTime<Calendar>>(other);
      return dateTime.to_moment().day_difference(om.dateTime.to_moment());
    }

day_of_m_cycle() [1/2]

template<IsDayCalendarSystem Calendar>

i32 mtcore::calendars::CalDateTime< Calendar >::day_of_m_cycle ( i32 m, i32 offset ) const

inlinenodiscard

Gets which day the current date occurs in an m-length ("month") cycle.

Parameters

m	Length of cycle
offset	Offset for start of cycle

Definition at line 579 of file calendars/mtcore_calendars/core.hpp.

{ return cal.to_fixed().day_of_m_cycle(m, offset); }

day_of_m_cycle() [2/2]

template<IsDayCalendarSystem Calendar>

i32 mtcore::calendars::CalDateTime< Calendar >::day_of_m_cycle ( i32 m, i32 offset ) const

inlinenodiscard

Gets which day the current date occurs in an m-length ("month") cycle.

Parameters

m	Length of cycle
offset	Offset for start of cycle

Definition at line 839 of file calendars/mtcore_calendars/core.hpp.

                                                              {
      return Moment::moment_to_fixed(dateTime.to_moment()).day_of_m_cycle(m, offset);
    }

Here is the call graph for this function:

day_of_week() [1/2]

template<IsDayCalendarSystem Calendar>

DayOfWeek mtcore::calendars::CalDateTime< Calendar >::day_of_week ( ) const

inlinenodiscardconstexpr

Gets the day of week for a date.

Definition at line 475 of file calendars/mtcore_calendars/core.hpp.

{ return cal.to_fixed().day_of_week(); }

day_of_week() [2/2]

template<IsDayCalendarSystem Calendar>

DayOfWeek mtcore::calendars::CalDateTime< Calendar >::day_of_week ( ) const

inlinenodiscardconstexpr

Gets the day of week for a date.

Definition at line 723 of file calendars/mtcore_calendars/core.hpp.

                                                          {
      return Moment::moment_to_fixed(dateTime.to_moment()).day_of_week();
    }

Here is the call graph for this function:

day_of_week_after() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_after ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week after the current date.

Definition at line 505 of file calendars/mtcore_calendars/core.hpp.

                                                                                   {
      return {Calendar::from_fixed(cal.to_fixed().day_of_week_after(k))};
    }

day_of_week_after() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_after ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week after the current date.

Definition at line 757 of file calendars/mtcore_calendars/core.hpp.

                                                                                   {
      return {Calendar::from_moment(
        Moment::reconstruct(Moment::moment_to_fixed(dateTime.to_moment()).day_of_week_after(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

day_of_week_before() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_before ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week before current date.

Definition at line 500 of file calendars/mtcore_calendars/core.hpp.

                                                                                    {
      return {Calendar::from_fixed(cal.to_fixed().day_of_week_before(k))};
    }

day_of_week_before() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_before ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week before current date.

Definition at line 751 of file calendars/mtcore_calendars/core.hpp.

                                                                                    {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).day_of_week_before(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

day_of_week_nearest() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_nearest ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week nearest to the current date.

Definition at line 510 of file calendars/mtcore_calendars/core.hpp.

                                                                                     {
      return {Calendar::from_fixed(cal.to_fixed().day_of_week_nearest(k))};
    }

day_of_week_nearest() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_nearest ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week nearest to the current date.

Definition at line 763 of file calendars/mtcore_calendars/core.hpp.

                                                                                     {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).day_of_week_nearest(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

day_of_week_on_or_after() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_on_or_after ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week on or after the current date.

Definition at line 520 of file calendars/mtcore_calendars/core.hpp.

                                                                                         {
      return {Calendar::from_fixed(cal.to_fixed().day_of_week_on_or_after(k))};
    }

day_of_week_on_or_after() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_on_or_after ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week on or after the current date.

Definition at line 775 of file calendars/mtcore_calendars/core.hpp.

                                                                                         {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).day_of_week_on_or_after(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

day_of_week_on_or_before() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_on_or_before ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week on or before the current date.

Definition at line 515 of file calendars/mtcore_calendars/core.hpp.

                                                                                          {
      return {Calendar::from_fixed(cal.to_fixed().day_of_week_on_or_before(k))};
    }

day_of_week_on_or_before() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::day_of_week_on_or_before ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the day of week on or before the current date.

Definition at line 769 of file calendars/mtcore_calendars/core.hpp.

                                                                                          {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).day_of_week_on_or_before(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

first_week_day() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::first_week_day ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the first week day in a month (assuming current date is the start of the month)

Definition at line 525 of file calendars/mtcore_calendars/core.hpp.

                                                                                {
      return {Calendar::from_fixed(cal.to_fixed().first_week_day(k))};
    }

first_week_day() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::first_week_day ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the first week day in a month (assuming current date is the start of the month)

Definition at line 781 of file calendars/mtcore_calendars/core.hpp.

                                                                                {
      return {Calendar::from_moment(
        Moment::reconstruct(Moment::moment_to_fixed(dateTime.to_moment()).first_week_day(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

is_valid() [1/2]

template<IsDayCalendarSystem Calendar>

bool mtcore::calendars::CalDateTime< Calendar >::is_valid ( ) const

inlinenodiscardconstexpr

Checks that a date is valid.

Definition at line 382 of file calendars/mtcore_calendars/core.hpp.

{ return *this == nearest_valid(); }

Here is the call graph for this function:

is_valid() [2/2]

template<IsDayCalendarSystem Calendar>

bool mtcore::calendars::CalDateTime< Calendar >::is_valid ( ) const

inlinenodiscardconstexpr

Checks that a date is valid.

Definition at line 642 of file calendars/mtcore_calendars/core.hpp.

{ return *this == nearest_valid(); }

Here is the call graph for this function:

kth_day_of_m_cycle_after() [1/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_after ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs after the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 621 of file calendars/mtcore_calendars/core.hpp.

                                                                                                        {
      return {Calendar::from_fixed(cal.to_fixed().kth_day_of_m_cycle_after(k, m, offset)), time};
    }

kth_day_of_m_cycle_after() [2/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_after ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs after the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 888 of file calendars/mtcore_calendars/core.hpp.

                                                                                                        {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).kth_day_of_m_cycle_after(k, m, offset), dateTime.to_moment()))};
    }

Here is the call graph for this function:

kth_day_of_m_cycle_before() [1/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_before ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs before the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 599 of file calendars/mtcore_calendars/core.hpp.

                                                                                                         {
      return {Calendar::from_fixed(cal.to_fixed().kth_day_of_m_cycle_before(k, m, offset)), time};
    }

kth_day_of_m_cycle_before() [2/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_before ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs before the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 863 of file calendars/mtcore_calendars/core.hpp.

                                                                                                         {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).kth_day_of_m_cycle_before(k, m, offset), dateTime.to_moment()))};
    }

Here is the call graph for this function:

kth_day_of_m_cycle_nearest() [1/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_nearest ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs nearest the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 632 of file calendars/mtcore_calendars/core.hpp.

                                                                                                          {
      return {Calendar::from_fixed(cal.to_fixed().kth_day_of_m_cycle_nearest(k, m, offset)), time};
    }

kth_day_of_m_cycle_nearest() [2/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_nearest ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs nearest the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 900 of file calendars/mtcore_calendars/core.hpp.

                                                                                                          {
      return {Calendar::from_moment(Moment::reconstruct(
        Moment::moment_to_fixed(dateTime.to_moment()).kth_day_of_m_cycle_nearest(k, m, offset), dateTime.to_moment()))};
    }

Here is the call graph for this function:

kth_day_of_m_cycle_on_or_after() [1/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_on_or_after ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs on or after the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 610 of file calendars/mtcore_calendars/core.hpp.

                                                                                                              {
      return {Calendar::from_fixed(cal.to_fixed().kth_day_of_m_cycle_on_or_after(k, m, offset)), time};
    }

kth_day_of_m_cycle_on_or_after() [2/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_on_or_after ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs on or after the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 875 of file calendars/mtcore_calendars/core.hpp.

                                                                                                              {
      return {Calendar::from_moment(
        Moment::reconstruct(Moment::moment_to_fixed(dateTime.to_moment()).kth_day_of_m_cycle_on_or_after(k, m, offset),
                            dateTime.to_moment()))};
    }

Here is the call graph for this function:

kth_day_of_m_cycle_on_or_before() [1/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_on_or_before ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs on or before the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 588 of file calendars/mtcore_calendars/core.hpp.

                                                                                                               {
      return {Calendar::from_fixed(cal.to_fixed().kth_day_of_m_cycle_on_or_before(k, m, offset)), time};
    }

kth_day_of_m_cycle_on_or_before() [2/2]

template<IsDayCalendarSystem Calendar>

auto mtcore::calendars::CalDateTime< Calendar >::kth_day_of_m_cycle_on_or_before ( i32 k, i32 m, i32 offset ) const -> CalDateTime

inlinenodiscardnoexcept

Finds the kth day of the m-cycle that occurs on or before the current date.

Parameters

k	The kth day of the m-cycle
m	The number of days in the m-cycle
offset	The offset of the m-cycle

Returns

A date with the result

Definition at line 850 of file calendars/mtcore_calendars/core.hpp.

                                                                                                               {
      return {Calendar::from_moment(
        Moment::reconstruct(Moment::moment_to_fixed(dateTime.to_moment()).kth_day_of_m_cycle_on_or_before(k, m, offset),
                            dateTime.to_moment()))};
    }

Here is the call graph for this function:

last_week_day() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::last_week_day ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the last week day in a month (assuming current date is the end of the month)

Definition at line 530 of file calendars/mtcore_calendars/core.hpp.

                                                                               {
      return {Calendar::from_fixed(cal.to_fixed().last_week_day(k))};
    }

last_week_day() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::last_week_day ( const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the last week day in a month (assuming current date is the end of the month)

Definition at line 787 of file calendars/mtcore_calendars/core.hpp.

                                                                               {
      return {Calendar::from_moment(
        Moment::reconstruct(Moment::moment_to_fixed(dateTime.to_moment()).last_week_day(k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

nearest_valid() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::nearest_valid ( ) const

inlinenodiscardconstexpr

Moves the date to the nearest valid date.

Definition at line 385 of file calendars/mtcore_calendars/core.hpp.

                                                              {
      auto nearestDate = cal.to_fixed().day;
      auto frac        = time.to_fraction_unchecked();
      if (frac < 0) {
        nearestDate -= math::floor(frac - 1);
      }
      else if (frac > 1) {
        nearestDate += math::floor(frac + 1);
      }
      frac = frac - math::floor(frac);
      return CalDateTime{Calendar::from_fixed(Fixed{nearestDate}), static_cast<Segments>(DayFraction{frac})};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

nearest_valid() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::nearest_valid ( ) const

inlinenodiscardconstexpr

Moves the date to the nearest valid date.

Definition at line 645 of file calendars/mtcore_calendars/core.hpp.

                                                              {
      return CalDateTime{Calendar::from_moment(dateTime.to_moment())};
    }

nth_week_day() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::nth_week_day ( const i32 n, const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the nth day of week.

Definition at line 495 of file calendars/mtcore_calendars/core.hpp.

                                                                                           {
      return {Calendar::from_fixed(cal.to_fixed().nth_week_day(n, k))};
    }

nth_week_day() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::nth_week_day ( const i32 n, const DayOfWeek k ) const

inlinenodiscardconstexpr

Gets the nth day of week.

Definition at line 745 of file calendars/mtcore_calendars/core.hpp.

                                                                                           {
      return {Calendar::from_moment(
        Moment::reconstruct(Moment::moment_to_fixed(dateTime.to_moment()).nth_week_day(n, k), dateTime.to_moment()))};
    }

Here is the call graph for this function:

operator CalDate< Calendar >()

template<IsDayCalendarSystem Calendar>

mtcore::calendars::CalDateTime< Calendar >::operator CalDate< Calendar > ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 379 of file calendars/mtcore_calendars/core.hpp.

{ return CalDate<Calendar>{cal}; }

operator CalDate< Fixed >()

template<IsDayCalendarSystem Calendar>

mtcore::calendars::CalDateTime< Calendar >::operator CalDate< Fixed > ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 655 of file calendars/mtcore_calendars/core.hpp.

                                                                     {
      return CalDate<Fixed>{{math::floor(dateTime.dayAndTime)}};
    }

Here is the call graph for this function:

operator CalDateTime< Other >() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

mtcore::calendars::CalDateTime< Calendar >::operator CalDateTime< Other > ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 399 of file calendars/mtcore_calendars/core.hpp.

                                                                         {
      if constexpr (IsDayCalendarSystem<Other>) {
        return {Other::from_fixed(cal.to_fixed()), time};
      }
      else {
        Moment t = {static_cast<f64>(cal.to_fixed().day) + time.to_fraction_unchecked()};
        return {Other::from_moment(t)};
      }
    }

operator CalDateTime< Other >() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

mtcore::calendars::CalDateTime< Calendar >::operator CalDateTime< Other > ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 660 of file calendars/mtcore_calendars/core.hpp.

                                                                         {
      if constexpr (IsTimeCalendarSystem<Other>) {
        return {Other::from_moment(dateTime.to_moment()), time};
      }
      else {
        const auto m       = dateTime.to_moment();
        const i32 day      = math::floor(dateTime.dayAndTime);
        const auto dayFrac = DayFraction{m.dayAndTime - math::floor(dateTime.dayAndTime)};
        return {
          Other::from_fixed(Fixed{day}),
          static_cast<Segments>(dayFrac),
        };
      }
    }

Here is the call graph for this function:

operator!=() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator!= ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 449 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp != decltype(cmp)::equivalent;
    }

operator!=() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator!= ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 697 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp != decltype(cmp)::equivalent;
    }

operator<() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator< ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 464 of file calendars/mtcore_calendars/core.hpp.

                                                                                      {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::less;
    }

operator<() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator< ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 712 of file calendars/mtcore_calendars/core.hpp.

                                                                                      {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::less;
    }

operator<=() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator<= ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 454 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::equivalent || cmp == decltype(cmp)::less;
    }

operator<=() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator<= ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 702 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::equivalent || cmp == decltype(cmp)::less;
    }

operator<=>() [1/4]

template<IsDayCalendarSystem Calendar>

template<IsTimeCalendarSystem Other>

std::partial_ordering mtcore::calendars::CalDateTime< Calendar >::operator<=> ( const CalDateTime< Other > & o ) const

inlinenodiscardconstexpr

Definition at line 410 of file calendars/mtcore_calendars/core.hpp.

                                                                                               {
      if constexpr (std::is_same_v<std::remove_cvref_t<Other>, std::remove_cvref_t<Calendar>>) {
        if (const std::partial_ordering cmp = cal <=> o.cal; cmp != std::partial_ordering::equivalent) {
          return cmp;
        }
        return time <=> o.time;
      }
      else {
        if (const std::partial_ordering cmp = cal.to_moment() <=> o.cal.to_moment();
            cmp != std::partial_ordering::equivalent) {
          return cmp;
        }
        return time <=> o.time;
      }
    }

operator<=>() [2/4]

template<IsDayCalendarSystem Calendar>

template<IsDayCalendarSystem Other>

std::partial_ordering mtcore::calendars::CalDateTime< Calendar >::operator<=> ( const CalDateTime< Other > & o ) const

inlinenodiscardconstexpr

Definition at line 427 of file calendars/mtcore_calendars/core.hpp.

                                                                                               {
      if constexpr (std::is_same_v<std::remove_cvref_t<Other>, std::remove_cvref_t<Calendar>>) {
        if (const std::strong_ordering cmp = cal <=> o.cal; cmp != std::strong_ordering::equivalent) {
          return cmp;
        }
        return time <=> o.time;
      }
      else {
        if (const std::strong_ordering cmp = cal.to_fixed() <=> o.cal.to_fixed();
            cmp != std::strong_ordering::equivalent) {
          return cmp;
        }
        return time <=> o.time;
      }
    }

operator<=>() [3/4]

template<IsDayCalendarSystem Calendar>

template<IsDayCalendarSystem Other>

std::partial_ordering mtcore::calendars::CalDateTime< Calendar >::operator<=> ( const CalDateTime< Other > & o ) const

inlinenodiscardconstexpr

Definition at line 676 of file calendars/mtcore_calendars/core.hpp.

                                                                                               {
      const auto om = static_cast<CalDateTime<Calendar>>(o);
      return *this <=> om;
    }

operator<=>() [4/4]

template<IsDayCalendarSystem Calendar>

template<IsTimeCalendarSystem Other>

std::partial_ordering mtcore::calendars::CalDateTime< Calendar >::operator<=> ( const CalDateTime< Other > & o ) const

inlinenodiscardconstexpr

Definition at line 682 of file calendars/mtcore_calendars/core.hpp.

                                                                                               {
      if constexpr (std::is_same_v<std::remove_cvref_t<Other>, std::remove_cvref_t<Calendar>>) {
        return dateTime <=> o.dateTime;
      }
      else {
        return dateTime.to_moment() <=> o.dateTime.to_moment();
      }
    }

operator==() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator== ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 444 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::equivalent;
    }

operator==() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator== ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 692 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::equivalent;
    }

operator>() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator> ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 469 of file calendars/mtcore_calendars/core.hpp.

                                                                                      {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::greater;
    }

operator>() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator> ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 717 of file calendars/mtcore_calendars/core.hpp.

                                                                                      {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::greater;
    }

operator>=() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator>= ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 459 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::equivalent || cmp == decltype(cmp)::greater;
    }

operator>=() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::operator>= ( const CalDateTime< Other > & o ) const -> bool

inlinenodiscardconstexpr

Definition at line 707 of file calendars/mtcore_calendars/core.hpp.

                                                                                       {
      auto cmp = *this <=> o;
      return cmp == decltype(cmp)::equivalent || cmp == decltype(cmp)::greater;
    }

positions_in_range() [1/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::positions_in_range ( Allocator & alloc, const CalDateTime< Other > & end, i32 pthMoment, i32 cDayCycle, i32 delta ) const -> Result<ArrayList<CalDateTime>, AllocationError>

inlinenodiscard

Return the cyclic positions in the range of the current date to the end date (exclusive) Used to collect all occurrences of events (e.g.

holidays) in an interval of time (e.g. a Gregorian year)

Assumes $0 \le pthMoment \lt cDayCycle$

Parameters

alloc	Allocator to use
end	End of the cyclic range
pthMoment	Starting pth moment search. First result on or after a given moment of the pth moment (basically the cycle start)
cDayCycle	The number of days in the occurrence day cycle (basically the cycle length)
delta	Congruent modulo of cDayCycle to the position of RdDate{0} in the repeating cycle (basically the cycle modulo offset)

Returns

Definition at line 550 of file calendars/mtcore_calendars/core.hpp.

                                                                                                              {
      Result<ArrayList<Fixed>, AllocationError> fixedRes = cal.to_fixed().positions_in_range(
        alloc, static_cast<CalDateTime<Fixed>>(end).cal.to_fixed(), pthMoment, cDayCycle, delta);
      if (fixedRes.is_error()) {
        return fixedRes.error();
      }
 
      auto fixedDates = fixedRes.value();
      mtdefer { fixedDates.deinit(alloc); };
      ArrayList<CalDateTime> res;
      if (const auto r = res.init(alloc, fixedDates.size()); r.is_error()) {
        return r.error();
      }
 
      auto iter = fixedDates.iter();
      Fixed cur = {};
      while (iter.next().copy_if_present(cur)) {
        ensure(res.push(CalDateTime{Calendar::from_fixed(cur), time}).is_success());
      }
 
      return success(res);
    }

Here is the call graph for this function:

positions_in_range() [2/2]

template<IsDayCalendarSystem Calendar>

template<typename Other>

auto mtcore::calendars::CalDateTime< Calendar >::positions_in_range ( Allocator & alloc, const CalDateTime< Other > & end, i32 pthMoment, i32 cDayCycle, i32 delta ) const -> Result<ArrayList<CalDateTime>, AllocationError>

inlinenodiscard

Return the cyclic positions in the range of the current date to the end date (exclusive) Used to collect all occurrences of events (e.g.

holidays) in an interval of time (e.g. a Gregorian year)

Assumes $0 \le pthMoment \lt cDayCycle$

Parameters

alloc	Allocator to use
end	End of the cyclic range
pthMoment	Starting pth moment search. First result on or after a given moment of the pth moment (basically the cycle start)
cDayCycle	The number of days in the occurrence day cycle (basically the cycle length)
delta	Congruent modulo of cDayCycle to the position of RdDate{0} in the repeating cycle (basically the cycle modulo offset)

Returns

Definition at line 808 of file calendars/mtcore_calendars/core.hpp.

                                                                                                              {
      const auto moment = dateTime.to_moment();
 
      Result<ArrayList<Fixed>, AllocationError> fixedRes = Moment::moment_to_fixed(moment).positions_in_range(
        alloc, static_cast<CalDateTime<Fixed>>(end).cal.to_fixed(), pthMoment, cDayCycle, delta);
      if (fixedRes.is_error()) {
        return fixedRes.error();
      }
 
      auto fixedDates = fixedRes.value();
      mtdefer { fixedDates.deinit(alloc); };
      ArrayList<CalDateTime> res;
      if (const auto r = res.init(alloc, fixedDates.size()); r.is_error()) {
        return r.error();
      }
 
      auto iter = fixedDates.iter();
      Fixed cur = {};
      while (iter.next().copy_if_present(cur)) {
        ensure(res.push(CalDateTime{Calendar::from_moment(Moment::reconstruct(cur, moment))}).is_success());
      }
 
      return success(res);
    }

Here is the call graph for this function:

sub_days() [1/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::sub_days ( const i32 days ) const

inlinenodiscardconstexpr

Subtracts n days from a date.

Definition at line 483 of file calendars/mtcore_calendars/core.hpp.

                                                                       {
      return {Calendar::from_fixed(cal.to_fixed().sub_days(days))};
    }

sub_days() [2/2]

template<IsDayCalendarSystem Calendar>

CalDateTime mtcore::calendars::CalDateTime< Calendar >::sub_days ( const i32 days ) const

inlinenodiscardconstexpr

Subtracts n days from a date.

Definition at line 733 of file calendars/mtcore_calendars/core.hpp.

                                                                       {
      return {Calendar::from_moment(dateTime.to_moment().sub_days(days))};
    }

time_segments() [1/2]

template<IsDayCalendarSystem Calendar>

Segments mtcore::calendars::CalDateTime< Calendar >::time_segments ( ) const

inlinenodiscardconstexpr

Definition at line 377 of file calendars/mtcore_calendars/core.hpp.

{ return time; }

time_segments() [2/2]

template<IsDayCalendarSystem Calendar>

Segments mtcore::calendars::CalDateTime< Calendar >::time_segments ( ) const

inlinenodiscardconstexpr

Definition at line 649 of file calendars/mtcore_calendars/core.hpp.

                                                           {
      const auto m  = dateTime.to_moment();
      const auto df = DayFraction{m - math::floor(m)};
      return static_cast<Segments>(df);
    }

Here is the call graph for this function:

Member Data Documentation

cal

template<IsDayCalendarSystem Calendar>

Calendar mtcore::calendars::CalDateTime< Calendar >::cal

Definition at line 374 of file calendars/mtcore_calendars/core.hpp.

dateTime

template<IsDayCalendarSystem Calendar>

Calendar mtcore::calendars::CalDateTime< Calendar >::dateTime

Definition at line 639 of file calendars/mtcore_calendars/core.hpp.

time

template<IsDayCalendarSystem Calendar>

Segments mtcore::calendars::CalDateTime< Calendar >::time = {}

Definition at line 375 of file calendars/mtcore_calendars/core.hpp.

{};

---

The documentation for this struct was generated from the following file:

• calendars/mtcore_calendars/core.hpp