Package org.neo4j.gds.api

Interface AdjacencyList

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

CompositeAdjacencyList, TransientCompressedList, TransientUncompressedList

public interface AdjacencyList
extends java.lang.AutoCloseable

The adjacency list for a mono-partite graph with an optional single relationship property. Provides access to the degree, and the target ids. The methods in here are not final and may be revised under the continuation of Adjacency Compression III – Return of the Iterator One particular change could be that properties will be returned from AdjacencyCursors instead from separate PropertyCursors.

Method Summary

Modifier and Type	Method	Description
default AdjacencyCursor	adjacencyCursor(long node)	Create a new cursor for the target ids of the given node.
AdjacencyCursor	adjacencyCursor(long node, double fallbackValue)	Create a new cursor for the target ids of the given node.
default AdjacencyCursor	adjacencyCursor(@Nullable AdjacencyCursor reuse, long node)	Create a new cursor for the target ids of the given node.
default AdjacencyCursor	adjacencyCursor(@Nullable AdjacencyCursor reuse, long node, double fallbackValue)	Create a new cursor for the target ids of the given node.
void	close()
int	degree(long node)	Returns the degree of a node.
AdjacencyCursor	rawAdjacencyCursor()	Create a new uninitialized cursor.

Method Detail

degree

int degree(long node)

Returns the degree of a node. Undefined behavior if the node does not exist.

adjacencyCursor

default AdjacencyCursor adjacencyCursor(long node)

Create a new cursor for the target ids of the given node. The cursor is not expected to return correct property values. NOTE: Whether and how AdjacencyCursors will return properties is unclear. Undefined behavior if the node does not exist.

adjacencyCursor

AdjacencyCursor adjacencyCursor(long node,
                                double fallbackValue)

Create a new cursor for the target ids of the given node. If the cursor cannot produce property values, it will yield the provided fallbackValue. NOTE: Whether and how AdjacencyCursors will return properties is unclear. Undefined behavior if the node does not exist.

adjacencyCursor

default AdjacencyCursor adjacencyCursor(@Nullable
                                        @Nullable AdjacencyCursor reuse,
                                        long node)

Create a new cursor for the target ids of the given node. The cursor is not expected to return correct property values. NOTE: Whether and how AdjacencyCursors will return properties is unclear. The implementation might try to reuse the provided reuse cursor, if possible. That is not guaranteed, however, implementation may choose to ignore the reuse cursor for any reason. Undefined behavior if the node does not exist.

adjacencyCursor

default AdjacencyCursor adjacencyCursor(@Nullable
                                        @Nullable AdjacencyCursor reuse,
                                        long node,
                                        double fallbackValue)

Create a new cursor for the target ids of the given node. If the cursor cannot produce property values, it will yield the provided fallbackValue. NOTE: Whether and how AdjacencyCursors will return properties is unclear. The implementation might try to reuse the provided reuse cursor, if possible. That is not guaranteed, however, implementation may choose to ignore the reuse cursor for any reason. Undefined behavior if the node does not exist.

rawAdjacencyCursor

AdjacencyCursor rawAdjacencyCursor()

Create a new uninitialized cursor. NOTE: In order to use the returned cursor AdjacencyCursor.init(long, int) must be called.

close

void close()

Specified by:

close in interface java.lang.AutoCloseable