NodeStateListI64

Bases: object

__eq__(value)

Return self==value.

__ge__(value)

Return self>=value.

__getitem__(key)

Return self[key].

__gt__(value)

Return self>value.

__iter__()

Implement iter(self).

__le__(value)

Return self<=value.

__len__()

Return len(self).

__lt__(value)

Return self<value.

__ne__(value)

Return self!=value.

__repr__()

Return repr(self).

bottom_k(k)

Compute the k smallest values

Parameters:

Name	Type	Description	Default
k	int	The number of values to return	required

Returns:

Type	Description
NodeStateListI64	The k smallest values as a node state

get(node, default=None)

Get value for node

Parameters:

Name	Type	Description	Default
node	NodeInput	the node	required
default	Optional[list[int]]	the default value. Defaults to None.	None

Returns:

Type	Description
Optional[list[int]]	the value for the node or the default value

items()

Iterate over items

Returns:

Type	Description
Iterator[Tuple[Node, list[int]]]	Iterator over items

max()

Return the maximum value

Returns:

Type	Description
Optional[list[int]]	The maximum value or None if empty

max_item()

Return largest value and corresponding node

Returns:

Type	Description
Optional[Tuple[Node, list[int]]]	The Node and maximum value or None if empty

median()

Return the median value

Returns:

Type	Description
value	Optional[list[int]]:

median_item()

Return median value and corresponding node

Returns:

Type	Description
Optional[Tuple[Node, list[int]]]	The median value or None if empty

min()

Return the minimum value

Returns:

Type	Description
Optional[list[int]]	The minimum value or None if empty

min_item()

Return smallest value and corresponding node

Returns:

Type	Description
Optional[Tuple[Node, list[int]]]	The Node and minimum value or None if empty

nodes()

Iterate over nodes

Returns:

Type	Description
Nodes	The nodes

sorted(reverse=False)

Sort by value

Parameters:

Name	Type	Description	Default
reverse	bool	If True, sort in descending order, otherwise ascending. Defaults to False.	False

Returns:

Type	Description
NodeStateListI64	Sorted node state

sorted_by_id()

Sort results by node id

Returns:

Type	Description
NodeStateListI64	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	the pandas DataFrame

top_k(k)

Compute the k largest values

Parameters:

Name	Type	Description	Default
k	int	The number of values to return	required

Returns:

Type	Description
NodeStateListI64	The k largest values as a node state

values()

Iterate over values

Returns:

Type	Description
Iterator[list[int]]	Iterator over values