Package org.neo4j.gds.core.huge

Class CompressedAdjacencyList

java.lang.Object

org.neo4j.gds.core.huge.CompressedAdjacencyList

All Implemented Interfaces:

java.lang.AutoCloseable, AdjacencyList

public final class CompressedAdjacencyList
extends java.lang.Object
implements AdjacencyList

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompressedAdjacencyList.DecompressingCursor

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
CompressedAdjacencyList(byte[][] pages, HugeIntArray degrees, HugeLongArray offsets)

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.
static org.neo4j.gds.core.utils.mem.MemoryEstimation	adjacencyListEstimation(boolean undirected)
static org.neo4j.gds.core.utils.mem.MemoryEstimation	adjacencyListEstimation(long avgDegree, long nodeCount)
static org.neo4j.gds.core.utils.mem.MemoryEstimation	adjacencyListEstimation(org.neo4j.gds.RelationshipType relationshipType, boolean undirected)
void	close()
int	degree(long node)	Returns the degree of a node.
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

Constructor Detail

CompressedAdjacencyList

public CompressedAdjacencyList(byte[][] pages,
                               HugeIntArray degrees,
                               HugeLongArray offsets)

Method Detail

adjacencyListEstimation

public static org.neo4j.gds.core.utils.mem.MemoryEstimation adjacencyListEstimation(org.neo4j.gds.RelationshipType relationshipType,
                                                                                    boolean undirected)

adjacencyListEstimation

public static org.neo4j.gds.core.utils.mem.MemoryEstimation adjacencyListEstimation(long avgDegree,
                                                                                    long nodeCount)

adjacencyListEstimation

@TestOnly
public static org.neo4j.gds.core.utils.mem.MemoryEstimation adjacencyListEstimation(boolean undirected)

close

public void close()

Specified by:

close in interface AdjacencyList

Specified by:

close in interface java.lang.AutoCloseable

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