EarliestDateTimeView
A lazy view over EarliestDateTime values for each node.
Methods
| Method | Description |
|---|---|
bottom_k | Compute the k smallest values |
collect | Compute all DateTime values and return the result as a list |
collect_valid | Compute all DateTime values and return the valid results as a list. Conversion errors and empty values are ignored |
compute | Compute all DateTime values and return the result as a NodeState. Fails if any DateTime error is encountered. |
compute_valid | Compute all values and only return the valid results as a NodeState. DateTime errors are ignored. |
get | Get value for node |
groups | Group by value |
items | Iterate over DateTimes |
items_valid | Iterate over valid DateTimes only. Ignore error and None values. |
iter_valid | Returns an iterator over all valid DateTime values. Conversion errors and empty values are ignored |
max | Return the maximum value |
max_item | Return largest value and corresponding node |
median | Return the median value |
median_item | Return median value and corresponding node |
min | Return the minimum value |
min_item | Return smallest value and corresponding node |
nodes | Iterate over nodes |
sorted | Sort by value. Note that 'None' values will always come after valid DateTime values |
sorted_by_id | Sort results by node id. Fails if any DateTime error is encountered. |
sorted_by_id_valid | Sort only non-error DateTimes by node id. DateTime errors are ignored. |
to_df | Convert results to pandas DataFrame |
top_k | Compute the k largest values |
values | Iterate over DateTimes |
values_valid | Iterate over valid DateTime values only. Ignore error and None values. |
Method Details
bottom_k
Signature: bottom_k(k)
Compute the k smallest values
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
k | int | - | The number of values to return |
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | The k smallest values as a node state |
collect
Compute all DateTime values and return the result as a list
Returns
| Type | Description |
|---|---|
| list[datetime, optional] | all values as a list |
collect_valid
Compute all DateTime values and return the valid results as a list. Conversion errors and empty values are ignored
Returns
| Type | Description |
|---|---|
| list[datetime] | all values as a list |
compute
Compute all DateTime values and return the result as a NodeState. Fails if any DateTime error is encountered.
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | the computed NodeState |
compute_valid
Compute all values and only return the valid results as a NodeState. DateTime errors are ignored.
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | the computed NodeState |
get
Signature: get(node, default=...)
Get value for node
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
node | NodeInput | - | the node |
default | datetime, optional | ... | the default value. Defaults to None. |
Returns
| Type | Description |
|---|---|
| datetime, optional | the value for the node or the default value |
groups
Group by value
Returns
| Type | Description |
|---|---|
| NodeGroups | The grouped nodes |
items
Iterate over DateTimes
items_valid
Iterate over valid DateTimes only. Ignore error and None values.
iter_valid
Returns an iterator over all valid DateTime values. Conversion errors and empty values are ignored
Returns
| Type | Description |
|---|---|
Iterator[datetime] | Valid datetime values. |
max
Return the maximum value
Returns
| Type | Description |
|---|---|
| datetime, optional | The maximum value or None if empty |
max_item
Return largest value and corresponding node
median
Return the median value
Returns
| Type | Description |
|---|---|
| datetime, optional | The median value or None if empty |
median_item
Return median value and corresponding node
min
Return the minimum value
Returns
| Type | Description |
|---|---|
| datetime, optional | The minimum value or None if empty |
min_item
Return smallest value and corresponding node
nodes
Iterate over nodes
Returns
| Type | Description |
|---|---|
| Nodes | The nodes |
sorted
Signature: sorted(reverse=False)
Sort by value. Note that 'None' values will always come after valid DateTime values
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
reverse | bool, optional | False | If True, sort in descending order, otherwise ascending. Defaults to False. |
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | Sorted node state |
sorted_by_id
Sort results by node id. Fails if any DateTime error is encountered.
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | The sorted node state |
sorted_by_id_valid
Sort only non-error DateTimes by node id. DateTime errors are ignored.
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | The sorted node state |
to_df
Convert results to pandas DataFrame
The DataFrame has two columns, "node" with the node ids and "value" with the corresponding values.
Returns
| Type | Description |
|---|---|
| DataFrame | A Pandas DataFrame. |
top_k
Signature: top_k(k)
Compute the k largest values
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
k | int | - | The number of values to return |
Returns
| Type | Description |
|---|---|
| NodeStateOptionDateTime | The k largest values as a node state |
values
Iterate over DateTimes
Returns
| Type | Description |
|---|---|
Iterator[Optional[datetime]] | Iterator over datetimes |
values_valid
Iterate over valid DateTime values only. Ignore error and None values.
Returns
| Type | Description |
|---|---|
Iterator[datetime] | Iterator over values |