Package org.neo4j.gds.core.compression.packed

Class PackedAdjacencyList

java.lang.Object

org.neo4j.gds.core.compression.packed.PackedAdjacencyList

All Implemented Interfaces:

AdjacencyList

public class PackedAdjacencyList
extends java.lang.Object
implements AdjacencyList

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.gds.api.AdjacencyList

AdjacencyList.MemoryInfo

Field Summary

Fields inherited from interface org.neo4j.gds.api.AdjacencyList

EMPTY

Method Summary

Modifier and Type	Method	Description
AdjacencyCursor	adjacencyCursor(long node, double fallbackValue)	Create a new cursor for the target ids of the given node.
AdjacencyCursor	adjacencyCursor(@Nullable AdjacencyCursor reuse, long node, double fallbackValue)	Create a new cursor for the target ids of the given node.
int	degree(long node)	Returns the degree of a node.
void	free()	Free the underlying memory.
AdjacencyList.MemoryInfo	memoryInfo()	Returns information about on heap and off heap memory usage of this adjacency list.
AdjacencyCursor	rawAdjacencyCursor()	Create a new uninitialized cursor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.neo4j.gds.api.AdjacencyList

adjacencyCursor, adjacencyCursor

Method Detail

degree

public int degree(long node)

Description copied from interface: AdjacencyList

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

Specified by:

degree in interface AdjacencyList

adjacencyCursor

public AdjacencyCursor adjacencyCursor(long node,
                                       double fallbackValue)

Description copied from interface: AdjacencyList

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.

Specified by:

adjacencyCursor in interface AdjacencyList

adjacencyCursor

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

Description copied from interface: AdjacencyList

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.

Specified by:

adjacencyCursor in interface AdjacencyList

rawAdjacencyCursor

public AdjacencyCursor rawAdjacencyCursor()

Description copied from interface: AdjacencyList

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

Specified by:

rawAdjacencyCursor in interface AdjacencyList

memoryInfo

public AdjacencyList.MemoryInfo memoryInfo()

Description copied from interface: AdjacencyList

Returns information about on heap and off heap memory usage of this adjacency list.

Specified by:

memoryInfo in interface AdjacencyList

free

@TestOnly
public void free()

Free the underlying memory.

This list cannot be used afterwards.

When this list is garbage collected, the memory is freed as well, so it is not required to call this method to prevent memory leaks.