Node

Bases: object

A node (or node) in the graph.

earliest_date_time property

Returns the earliest datetime that the node exists.

Returns:

Type	Description
datetime	The earliest datetime that the node exists as a Datetime.

earliest_time property

Returns the earliest time that the node exists.

Returns:

Type	Description
int	The earliest time that the node exists as an integer.

edges property

Get the edges that are incident to this node.

Returns:

 Edges: The incident edges.

end property

Gets the latest time that this Node is valid.

Returns:

Type	Description
Optional[int]	The latest time that this Node is valid or None if the Node is valid for all times.

end_date_time property

Gets the latest datetime that this Node is valid

Returns:

Type	Description
Optional[datetime]	The latest datetime that this Node is valid or None if the Node is valid for all times.

id property

Returns the id of the node. This is a unique identifier for the node.

Returns:

Type	Description
str | int	The id of the node.

in_edges property

Get the edges that point into this node.

Returns:

 Edges: The inbound edges.

in_neighbours property

Get the neighbours of this node that point into this node.

Returns:

 PathFromNode: The in-neighbours.

latest_date_time property

Returns the latest datetime that the node exists.

Returns:

Type	Description
datetime	The latest datetime that the node exists as a Datetime.

latest_time property

Returns the latest time that the node exists.

Returns:

Type	Description
int	The latest time that the node exists as an integer.

metadata property

The metadata of the node

Returns:

Type	Description
Metadata

name property

Returns the name of the node.

Returns:

Type	Description
str	The id of the node as a string.

neighbours property

Get the neighbours of this node.

Returns:

 PathFromNode: The neighbours (both inbound and outbound).

node_type property

Returns the type of node

Returns:

Type	Description
Optional[str]	The node type if it is set or None otherwise.

out_edges property

Get the edges that point out of this node.

Returns:

 Edges: The outbound edges.

out_neighbours property

Get the neighbours of this node that point out of this node.

Returns:

 PathFromNode: The out-neighbours.

properties property

The properties of the node

Returns:

Type	Description
Properties	A list of properties.

start property

Gets the start time for rolling and expanding windows for this Node

Returns:

Type	Description
Optional[int]	The earliest time that this Node is valid or None if the Node is valid for all times.

start_date_time property

Gets the earliest datetime that this Node is valid

Returns:

Type	Description
Optional[datetime]	The earliest datetime that this Node is valid or None if the Node is valid for all times.

window_size property

Get the window size (difference between start and end) for this Node

Returns:

Type	Description
Optional[int]

__eq__(value)

Return self==value.

__ge__(value)

Return self>=value.

__getitem__(key)

Return self[key].

__gt__(value)

Return self>value.

__hash__()

Return hash(self).

__le__(value)

Return self<=value.

__lt__(value)

Return self<value.

__ne__(value)

Return self!=value.

__repr__()

Return repr(self).

after(start)

Create a view of the Node including all events after start (exclusive).

Parameters:

Name	Type	Description	Default
start	TimeInput	The start time of the window.	required

Returns:

Type	Description
Node

at(time)

Create a view of the Node including all events at time.

Parameters:

Name	Type	Description	Default
time	TimeInput	The time of the window.	required

Returns:

Type	Description
Node

before(end)

Create a view of the Node including all events before end (exclusive).

Parameters:

Name	Type	Description	Default
end	TimeInput	The end time of the window.	required

Returns:

Type	Description
Node

default_layer()

Return a view of Node containing only the default edge layer Returns: Node: The layered view

degree()

Get the degree of this node (i.e., the number of edges that are incident to it).

Returns:

Type	Description
int	The degree of this node.

edge_history_count()

Get the number of edge events for this node

Returns:

Type	Description
int	The number of edge events

exclude_layer(name)

Return a view of Node containing all layers except the excluded name Errors if any of the layers do not exist.

Parameters:

Name	Type	Description	Default
name	str	layer name that is excluded for the new view	required

Returns:

Type	Description
Node	The layered view

exclude_layers(names)

Return a view of Node containing all layers except the excluded names Errors if any of the layers do not exist.

Parameters:

Name	Type	Description	Default
names	list[str]	list of layer names that are excluded for the new view	required

Returns:

Type	Description
Node	The layered view

exclude_valid_layer(name)

Return a view of Node containing all layers except the excluded name Arguments: name (str): layer name that is excluded for the new view

Returns:

Type	Description
Node	The layered view

exclude_valid_layers(names)

Return a view of Node containing all layers except the excluded names Arguments: names (list[str]): list of layer names that are excluded for the new view

Returns:

Type	Description
Node	The layered view

expanding(step)

Creates a WindowSet with the given step size using an expanding window.

An expanding window is a window that grows by step size at each iteration.

Parameters:

Name	Type	Description	Default
step	int | str	The step size of the window.	required

Returns:

Type	Description
WindowSet	A WindowSet object.

filter_edges(filter)

Return a filtered view that only includes edges that satisfy the filter

Parameters:

Name	Type	Description	Default
filter	FilterExpr	The filter to apply to the edges.	required

Returns:

Type	Description
Node	The filtered view

filter_exploded_edges(filter)

Return a filtered view that only includes exploded edges that satisfy the filter

Parameters:

Name	Type	Description	Default
filter	FilterExpr	The filter to apply to the exploded edge properties.	required

Returns:

Type	Description
Node	The filtered view

filter_nodes(filter)

Return a filtered view that only includes nodes that satisfy the filter

Parameters:

Name	Type	Description	Default
filter	FilterExpr	The filter to apply to the nodes.	required

Returns:

Type	Description
Node	The filtered view

has_layer(name)

Check if Node has the layer "name"

Parameters:

Name	Type	Description	Default
name	str	the name of the layer to check	required

Returns:

Type	Description
bool

history()

Returns the history of a node, including node additions and changes made to node.

Returns:

Type	Description
List[int]	A list of unix timestamps of the event history of node.

history_date_time()

Returns the history of a node, including node additions and changes made to node.

Returns:

Type	Description
List[datetime]	A list of timestamps of the event history of node.

in_degree()

Get the in-degree of this node (i.e., the number of edges that are incident to it from other nodes).

Returns:

Type	Description
int	The in-degree of this node.

is_active()

Check if the node is active (it's history is not empty).

Returns:

Type	Description
bool

latest()

Create a view of the Node including all events at the latest time.

Returns:

Type	Description
Node

layer(name)

Return a view of Node containing the layer "name" Errors if the layer does not exist

Parameters:

Name	Type	Description	Default
name	str	then name of the layer.	required

Returns:

Type	Description
Node	The layered view

layers(names)

Return a view of Node containing all layers names Errors if any of the layers do not exist.

Parameters:

Name	Type	Description	Default
names	list[str]	list of layer names for the new view	required

Returns:

Type	Description
Node	The layered view

out_degree()

Get the out-degree of this node (i.e., the number of edges that are incident to it from this node).

Returns:

Type	Description
int	The out-degree of this node.

rolling(window, step=None)

Creates a WindowSet with the given window size and optional step using a rolling window.

A rolling window is a window that moves forward by step size at each iteration.

Parameters:

Name	Type	Description	Default
window	int | str	The size of the window.	required
step	int | str | None	The step size of the window. step defaults to window.	None

Returns:

Type	Description
WindowSet	A WindowSet object.

shrink_end(end)

Set the end of the window to the smaller of end and self.end()

Parameters:

Name	Type	Description	Default
end	TimeInput	the new end time of the window	required

Returns: Node:

shrink_start(start)

Set the start of the window to the larger of start and self.start()

Parameters:

Name	Type	Description	Default
start	TimeInput	the new start time of the window	required

Returns:

Type	Description
Node

shrink_window(start, end)

Shrink both the start and end of the window (same as calling shrink_start followed by shrink_end but more efficient)

Parameters:

Name	Type	Description	Default
start	TimeInput	the new start time for the window	required
end	TimeInput	the new end time for the window	required

Returns:

Type	Description
Node

snapshot_at(time)

Create a view of the Node including all events that have not been explicitly deleted at time.

This is equivalent to before(time + 1) for Graph and at(time) for PersistentGraph

Parameters:

Name	Type	Description	Default
time	TimeInput	The time of the window.	required

Returns:

Type	Description
Node

snapshot_latest()

Create a view of the Node including all events that have not been explicitly deleted at the latest time.

This is equivalent to a no-op for Graph and latest() for PersistentGraph

Returns:

Type	Description
Node

valid_layers(names)

Return a view of Node containing all layers names Any layers that do not exist are ignored

Parameters:

Name	Type	Description	Default
names	list[str]	list of layer names for the new view	required

Returns:

Type	Description
Node	The layered view

window(start, end)

Create a view of the Node including all events between start (inclusive) and end (exclusive)

Parameters:

Name	Type	Description	Default
start	TimeInput | None	The start time of the window (unbounded if None).	required
end	TimeInput | None	The end time of the window (unbounded if None).	required

Returns:

Type	Description
Node