View source code Display the source code in std/datetime.d from which this page was generated on github. Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

std.datetime.interval.contains - multiple declarations

Function Interval.contains

Whether the given time point is within this interval.

Prototype

bool contains(
  TP timePoint
) const pure;

Parameters

NameDescription
timePoint The time point to check for inclusion in this interval.

Throws

DateTimeException if this interval is empty.

Examples

assert(!Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            Date(1994, 12, 24)));

assert(Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            Date(2000, 1, 5)));
assert(!Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            Date(2012, 3, 1)));

Function Interval.contains

Whether the given interval is completely within this interval.

Prototype

bool contains(
  Interval interval
) const pure;

Parameters

NameDescription
interval The interval to check for inclusion in this interval.

Throws

DateTimeException if either interval is empty.

Examples

assert(!Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            Interval!Date(Date(1990, 7, 6), Date(2000, 8, 2))));

assert(Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            Interval!Date(Date(1999, 1, 12), Date(2011, 9, 17))));

assert(!Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            Interval!Date(Date(1998, 2, 28), Date(2013, 5, 1))));

Function Interval.contains

Whether the given interval is completely within this interval.

Always returns false (unless this interval is empty), because an interval going to positive infinity can never be contained in a finite interval.

Prototype

bool contains(
  PosInfInterval!TP interval
) const pure;

Parameters

NameDescription
interval The interval to check for inclusion in this interval.

Throws

DateTimeException if this interval is empty.

Examples

assert(!Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            PosInfInterval!Date(Date(1999, 5, 4))));

Function Interval.contains

Whether the given interval is completely within this interval.

Always returns false (unless this interval is empty), because an interval beginning at negative infinity can never be contained in a finite interval.

Prototype

bool contains(
  NegInfInterval!TP interval
) const pure;

Parameters

NameDescription
interval The interval to check for inclusion in this interval.

Throws

DateTimeException if this interval is empty.

Examples

assert(!Interval!Date(Date(1996, 1, 2), Date(2012, 3, 1)).contains(
            NegInfInterval!Date(Date(1996, 5, 4))));

Authors

Jonathan M Davis and Kato Shoichi

License

Boost License 1.0.

Comments