params

parameters

arguments

args

Default parameter descriptions which may be overridden in individual
functions.

internal

Implements the phinterval vector class for representing time
spans that may contain gaps (disjoint intervals) or be empty. This class
generalizes the 'lubridate' package's interval class to support vectorized
set operations (intersection, union, difference, complement) that always
return a valid time span, even when disjoint or empty intervals are created.

Ethan Sansom

phinterval

Set Operations on Time Intervals

params function

<dl><dt>phint1, phint2</dt>
<dd><code>[phinterval / Interval]</code>
A pair of <code>&lt;phinterval&gt;</code> or <code>&lt;Interval&gt;</code> vectors. <code>phint1</code> and <code>phint2</code>
are recycled to a common length using vctrs-style recycling.</dd>
<dt>phint</dt>
<dd><code>[phinterval / Interval]</code>
A <code>&lt;phinterval&gt;</code> or <code>&lt;Interval&gt;</code> vector.</dd>
<dt>bounds</dt>
<dd><code>["[]" / "()"]</code>
Whether span endpoints are inclusive or exclusive:<ul>
<li><code>"[]"</code> (default): Closed intervals - both endpoints are included</li>
<li><code>"()"</code>: Open intervals - both endpoints are excluded</li>
</ul></dd>This affects adjacency and overlap detection. For example, with <code>bounds = "[]"</code>,
the intervals <code>[1, 5]</code> and <code>[5, 10]</code> are considered adjacent (they share the
endpoint 5), while with <code>bounds = "()"</code>, <code>(1, 5)</code> and <code>(5, 10)</code> are disjoint
(neither includes 5).</dl>

Arguments

Parameter Descriptions for phinterval Package — params

<dl>

<dt>phint1, phint2</dt>
<dd><code>[phinterval / Interval]</code>
A pair of <code>&lt;phinterval&gt;</code> or <code>&lt;Interval&gt;</code> vectors. <code>phint1</code> and <code>phint2</code>
are recycled to a common length using vctrs-style recycling.</dd>


<dt>phint</dt>
<dd><code>[phinterval / Interval]</code>
A <code>&lt;phinterval&gt;</code> or <code>&lt;Interval&gt;</code> vector.</dd>


<dt>bounds</dt>
<dd><code>["[]" / "()"]</code>
Whether span endpoints are inclusive or exclusive:<ul>
<li><code>"[]"</code> (default): Closed intervals - both endpoints are included</li>
<li><code>"()"</code>: Open intervals - both endpoints are excluded</li>
</ul>

This affects adjacency and overlap detection. For example, with <code>bounds = "[]"</code>,
the intervals <code>[1, 5]</code> and <code>[5, 10]</code> are considered adjacent (they share the
endpoint 5), while with <code>bounds = "()"</code>, <code>(1, 5)</code> and <code>(5, 10)</code> are disjoint
(neither includes 5).</dd>

</dl>

params: Parameter Descriptions for phinterval Package

Description

Value

Arguments