yawning_titan.envs.specific.core.nsa_node_collection.NodeCollection#

class yawning_titan.envs.specific.core.nsa_node_collection.NodeCollection(network, chance_to_spread_during_patch)[source]#

Class representing a collection of nodes for the 18-node Ridley Environment.

Methods

`calculate_reward`	Calculate a reward for the current network state.
`get_compromised_nodes`	Create a list of all the nodes in the network that are compromised.
`get_connected_nodes`	When given a node returns a list of all of the nodes connected to that node.
`get_isolated_nodes`	Create a list of all the isolated nodes in the network.
`get_netx_graph`	Get the underlying networkx graph.
`get_netx_pos`	Get graph positions.
`get_number_of_isolated`	Get the number of isolated nodes in the network.
`get_number_of_nodes`	Return the number of nodes in the network.
`get_number_of_un_compromised`	Get the number of safe nodes in the network.
`get_observation`	Get the states of all the nodes in the network.
`get_un_compromised_nodes`	Create a list of all the safe nodes in the network.
`modify_node`	Change the state of a single node.
`spread`	Spread the red agent through all connected nodes.

get_number_of_nodes()[source]#

Return the number of nodes in the network.

get_observation()[source]#

Get the states of all the nodes in the network.

modify_node(number, changes)[source]#

Change the state of a single node.

Parameters:

number – the number of the node to change
changes –
a list with two variables in [isolate, compromise] isolate: A boolean that will if true change the isolation status of the node (true -> false,

false -> true) (boolean)

compromise: a mode signal that will change the state of a node. 0 does nothing, 1 makes it safe and
2 compromises the node (int)

get_compromised_nodes()[source]#

Create a list of all the nodes in the network that are compromised.

get_un_compromised_nodes()[source]#

Create a list of all the safe nodes in the network.

get_isolated_nodes()[source]#

Create a list of all the isolated nodes in the network.

get_number_of_isolated()[source]#

Get the number of isolated nodes in the network.

get_number_of_un_compromised()[source]#

Get the number of safe nodes in the network.

get_connected_nodes(number)[source]#

When given a node returns a list of all of the nodes connected to that node.

Parameters:: number – the number of the node to run on
Returns:: a list of all the nodes connected to a specified node (list of ints)

spread(number)[source]#

Spread the red agent through all connected nodes.

calculate_reward()[source]#

Calculate a reward for the current network state.

get_netx_graph()[source]#

Get the underlying networkx graph.