NodeStateString#

class NodeStateString#

Bases: object

Methods:

`bottom_k`(k)	Compute the k smallest values
`get`(node[, default])	Get value for node
`groups`()	Group by value
`items`()	Iterate over items
`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`([reverse])	Sort by value
`sorted_by_id`()	Sort results by node id
`to_df`()	Convert results to pandas DataFrame
`top_k`(k)	Compute the k largest values
`values`()	Iterate over values

bottom_k(k)#

Compute the k smallest values

Parameters:: k (int) – The number of values to return
Returns:: The k smallest values as a node state
Return type:: NodeStateString

get(node, default=...)#

Get value for node

Parameters:

node (NodeInput) – the node
default (Optional[str]) – the default value. Defaults to None.

Returns:

the value for the node or the default value

Return type:

Optional[str]

groups()#

Group by value

Returns:: The grouped nodes
Return type:: NodeGroups

items()#

Iterate over items

Returns:: Iterator over items
Return type:: Iterator[Tuple[Node, str]]

max()#

Return the maximum value

Returns:: The maximum value or None if empty
Return type:: Optional[str]

max_item()#

Return largest value and corresponding node

Returns:: The Node and maximum value or None if empty
Return type:: Optional[Tuple[Node, str]]

median()#

Return the median value

Return type:: Optional[str]

median_item()#

Return median value and corresponding node

Returns:: The median value or None if empty
Return type:: Optional[Tuple[Node, str]]

min()#

Return the minimum value

Returns:: The minimum value or None if empty
Return type:: Optional[str]

min_item()#

Return smallest value and corresponding node

Returns:: The Node and minimum value or None if empty
Return type:: Optional[Tuple[Node, str]]

nodes()#

Iterate over nodes

Returns:: The nodes
Return type:: Nodes

sorted(reverse=False)#

Sort by value

Parameters:: reverse (bool) – If True, sort in descending order, otherwise ascending. Defaults to False.
Returns:: Sorted node state
Return type:: NodeStateString

sorted_by_id()#

Sort results by node id

Returns:: The sorted node state
Return type:: NodeStateString

to_df()#

Convert results to pandas DataFrame

The DataFrame has two columns, “node” with the node ids and “value” with the corresponding values.

Returns:: the pandas DataFrame
Return type:: DataFrame

top_k(k)#

Compute the k largest values

Parameters:: k (int) – The number of values to return
Returns:: The k largest values as a node state
Return type:: NodeStateString

values()#

Iterate over values

Returns:: Iterator over values
Return type:: Iterator[str]