NodeStateF64
Methods
| Method | Description |
|---|---|
bottom_k | Compute the k smallest values |
get | Get value for node |
items | Iterate over items |
max | Return the maximum value |
max_item | Return largest value and corresponding node |
mean | mean of values over all nodes |
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 |
sorted_by_id | Sort results by node id |
sum | sum of values over all nodes |
to_df | Convert results to pandas DataFrame |
top_k | Compute the k largest values |
values | Iterate over 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 |
|---|---|
| NodeStateF64 | The k smallest values as a node state |
get
Signature: get(node, default=None)
Get value for node
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
node | NodeInput | - | the node |
default | float, optional | None | the default value. Defaults to None. |
Returns
| Type | Description |
|---|---|
| float, optional | the value for the node or the default value |
items
Iterate over items
max
Return the maximum value
Returns
| Type | Description |
|---|---|
| float, optional | The maximum value or None if empty |
max_item
Return largest value and corresponding node
mean
mean of values over all nodes
Returns
| Type | Description |
|---|---|
| float | mean value |
median
Return the median value
Returns
| Type | Description |
|---|---|
| PropValue | Optional[float]: |
median_item
Return median value and corresponding node
min
Return the minimum value
Returns
| Type | Description |
|---|---|
| float, 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
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
reverse | bool, optional | False | If True, sort in descending order, otherwise ascending. Defaults to False. |
Returns
| Type | Description |
|---|---|
| NodeStateF64 | Sorted node state |
sorted_by_id
Sort results by node id
Returns
| Type | Description |
|---|---|
| NodeStateF64 | The sorted node state |
sum
sum of values over all nodes
Returns
| Type | Description |
|---|---|
| PropValue | float: the sum |
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 | the 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 |
|---|---|
| NodeStateF64 | The k largest values as a node state |
values
Iterate over values
Returns
| Type | Description |
|---|---|
Iterator[float] | Iterator over values |