Node

A node (or node) in the graph.

Methods

Method	Description
`after`	Create a view of the Node including all events after `start` (exclusive).
`at`	Create a view of the Node including all events at `time`.
`before`	Create a view of the Node including all events before `end` (exclusive).
`default_layer`	Return a view of Node containing only the default edge layer
`degree`	Get the degree of this node (i.e., the number of edges that are incident to it).
`edge_history_count`	Get the number of edge events for this node
`exclude_layer`	Return a view of Node containing all layers except the excluded `name`
`exclude_layers`	Return a view of Node containing all layers except the excluded `names`
`exclude_valid_layer`	Return a view of Node containing all layers except the excluded `name`
`exclude_valid_layers`	Return a view of Node containing all layers except the excluded `names`
`expanding`	Creates a `WindowSet` with the given `step` size using an expanding window.
`filter`	Return a filtered view that only includes nodes and edges that satisfy the filter
`has_layer`	Check if Node has the layer `"name"`
`in_degree`	Get the in-degree of this node (i.e., the number of edges that are incident to it from other nodes).
`is_active`	Check if the node is active (it's history is not empty).
`latest`	Create a view of the Node including all events at the latest time.
`layer`	Return a view of Node containing the layer `"name"`
`layers`	Return a view of Node containing all layers `names`
`out_degree`	Get the out-degree of this node (i.e., the number of edges that are incident to it from this node).
`rolling`	Creates a `WindowSet` with the given `window` size and optional `step` using a rolling window.
`shrink_end`	Set the end of the window to the smaller of `end` and `self.end()`
`shrink_start`	Set the start of the window to the larger of `start` and `self.start()`
`shrink_window`	Shrink both the start and end of the window (same as calling `shrink_start` followed by `shrink_end` but more efficient)
`snapshot_at`	Create a view of the Node including all events that have not been explicitly deleted at `time`.
`snapshot_latest`	Create a view of the Node including all events that have not been explicitly deleted at the latest time.
`valid_layers`	Return a view of Node containing all layers `names`
`window`	Create a view of the Node including all events between `start` (inclusive) and `end` (exclusive)

Properties

Property	Description
`earliest_time`	Returns the earliest time that the node exists.
`edges`	Get the edges that are incident to this node.
`end`	Gets the latest time that this Node is valid.
`history`	Returns the history of a node, including node additions and changes made to node.
`id`	Returns the id of the node.
`in_edges`	Get the edges that point into this node.
`in_neighbours`	Get the neighbours of this node that point into this node.
`latest_time`	Returns the latest time that the node exists.
`metadata`	The metadata of the node
`name`	Returns the name of the node.
`neighbours`	Get the neighbours of this node.
`node_type`	Returns the type of node
`out_edges`	Get the edges that point out of this node.
`out_neighbours`	Get the neighbours of this node that point out of this node.
`properties`	The properties of the node
`start`	Gets the start time for rolling and expanding windows for this Node
`window_size`	Get the window size (difference between start and end) for this Node.

Method Details

after

Signature: after(start)

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

Parameters

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

Returns

Type	Description
Node

at

Signature: at(time)

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

Parameters

Name	Type	Default	Description
`time`	TimeInput	-	The time of the window.

Returns

Type	Description
Node

before

Signature: before(end)

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

Parameters

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

Returns

Type	Description
Node

default_layer

Return a view of Node containing only the default edge layer

Returns

Type	Description
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

Signature: 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	Default	Description
`name`	str	-	layer name that is excluded for the new view

Returns

Type	Description
Node	The layered view

exclude_layers

Signature: 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	Default	Description
`names`	list[str]	-	list of layer names that are excluded for the new view

Returns

Type	Description
Node	The layered view

exclude_valid_layer

Signature: exclude_valid_layer(name)

Return a view of Node containing all layers except the excluded name

Parameters

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

Returns

Type	Description
Node	The layered view

exclude_valid_layers

Signature: exclude_valid_layers(names)

Return a view of Node containing all layers except the excluded names

Parameters

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

Returns

Type	Description
Node	The layered view

expanding

Signature: expanding(step, alignment_unit=None)

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	Default	Description
`step`	int \| str	-	The step size of the window.
`alignment_unit`	str \| None, optional	`None`	If no alignment_unit is passed, aligns the start of the first window to the smallest unit of time passed to step. For example, if the step is "1 month and 1 day", the windows will be aligned on days (00:00:00 to 23:59:59). If set to "unaligned", the first window will begin at the first time event. If any other alignment unit is passed, the windows will be aligned to that unit. alignment_unit defaults to None.

Returns

Type	Description
WindowSet	A `WindowSet` object.

filter

Signature: filter(filter)

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

Parameters

Name	Type	Default	Description
`filter`	`filter.FilterExpr`	-	The filter to apply to the nodes and edges.

Returns

Type	Description
Node	The filtered view

has_layer

Signature: has_layer(name)

Check if Node has the layer "name"

Parameters

Name	Type	Default	Description
`name`	str	-	the name of the layer to check

Returns

Type	Description
bool

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

Signature: layer(name)

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

Parameters

Name	Type	Default	Description
`name`	str	-	then name of the layer.

Returns

Type	Description
Node	The layered view

layers

Signature: layers(names)

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

Parameters

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

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

Signature: rolling(window, step=None, alignment_unit=None)

Creates a WindowSet with the given window size and optional step using a rolling window. If alignment_unit is not "unaligned" and a step larger than window is provided, some time entries may appear before the start of the first window and/or after the end of the last window (i.e. not included in any window).

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

Parameters

Name	Type	Default	Description
`window`	int \| str	-	The size of the window.
`step`	int \| str \| None, optional	`None`	The step size of the window. `step` defaults to `window`.
`alignment_unit`	str \| None, optional	`None`	If no alignment_unit is passed, aligns the start of the first window to the smallest unit of time passed to step (or window if no step is passed). For example, if the step is "1 month and 1 day", the first window will begin at the start of the day of the first time event. If set to "unaligned", the first window will begin at the first time event. If any other alignment unit is passed, the windows will be aligned to that unit. alignment_unit defaults to None.

Returns

Type	Description
WindowSet	A `WindowSet` object.

shrink_end

Signature: shrink_end(end)

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

Parameters

Name	Type	Default	Description
`end`	TimeInput	-	the new end time of the window

Returns

Type	Description
Node

shrink_start

Signature: shrink_start(start)

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

Parameters

Name	Type	Default	Description
`start`	TimeInput	-	the new start time of the window

Returns

Type	Description
Node

shrink_window

Signature: 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	Default	Description
`start`	TimeInput	-	the new start time for the window
`end`	TimeInput	-	the new end time for the window

Returns

Type	Description
Node

snapshot_at

Signature: 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	Default	Description
`time`	TimeInput	-	The time of the window.

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

Signature: valid_layers(names)

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

Parameters

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

Returns

Type	Description
Node	The layered view

window

Signature: window(start, end)

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

Parameters

Name	Type	Default	Description
`start`	TimeInput	-	The start time of the window.
`end`	TimeInput	-	The end time of the window.

Returns

Type	Description
Node

Property Details

earliest_time

Returns the earliest time that the node exists.

Returns

Type	Description
OptionalEventTime	The earliest time that the node exists.

edges

Get the edges that are incident to this node.

Returns

Type	Description
Edges	The incident edges.

end

Gets the latest time that this Node is valid.

Returns

Type	Description
OptionalEventTime	The latest time that this Node is valid or None if the Node is valid for all times.

history

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

Returns

Type	Description
History	A History object for the node, providing access to time entries.

id

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

Get the edges that point into this node.

Returns

Type	Description
Edges	The inbound edges.

in_neighbours

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

Returns

Type	Description
PathFromNode	The in-neighbours.

latest_time

Returns the latest time that the node exists.

Returns

Type	Description
OptionalEventTime	The latest time that the node exists.

metadata

The metadata of the node

Returns

Type	Description
Metadata

name

Returns the name of the node.

Returns

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

neighbours

Get the neighbours of this node.

Returns

Type	Description
PathFromNode	The neighbours (both inbound and outbound).

node_type

Returns the type of node

Returns

Type	Description
str, optional	The node type if it is set or `None` otherwise.

out_edges

Get the edges that point out of this node.

Returns

Type	Description
Edges	The outbound edges.

out_neighbours

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

Returns

Type	Description
PathFromNode	The out-neighbours.

properties

The properties of the node

Returns

Type	Description
Properties	A list of properties.

start

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

Returns

Type	Description
OptionalEventTime	The earliest time that this Node is valid or None if the Node is valid for all times.

window_size

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

Returns

Type	Description
int, optional