Package org.neo4j.gds.core.huge

Class TransientUncompressedList

java.lang.Object

org.neo4j.gds.core.huge.TransientUncompressedList

All Implemented Interfaces:

java.lang.AutoCloseable, AdjacencyList, AdjacencyProperties

public final class TransientUncompressedList
extends java.lang.Object
implements AdjacencyList, AdjacencyProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransientUncompressedList.Cursor

Constructor Summary

Constructors

Constructor	Description
TransientUncompressedList(long[][] 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)
static org.neo4j.gds.core.utils.mem.MemoryEstimation	adjacencyPropertiesEstimation(org.neo4j.gds.RelationshipType relationshipType, boolean undirected)
void	close()
int	degree(long node)	Returns the degree of a node.
PropertyCursor	propertyCursor(long node, double fallbackValue)	Create a new cursor for the properties of the relationships of a given node.
PropertyCursor	propertyCursor(PropertyCursor reuse, long node, double fallbackValue)	Create a new cursor for the properties of the relationships of a given node.
AdjacencyCursor	rawAdjacencyCursor()	Create a new uninitialized cursor.
PropertyCursor	rawPropertyCursor()	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

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

propertyCursor, propertyCursor

Constructor Detail

TransientUncompressedList

public TransientUncompressedList(long[][] 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

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

adjacencyListEstimation

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

adjacencyPropertiesEstimation

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

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

close

public void close()

Specified by:

close in interface AdjacencyList

Specified by:

close in interface AdjacencyProperties

Specified by:

close in interface java.lang.AutoCloseable

propertyCursor

public PropertyCursor propertyCursor(long node,
                                     double fallbackValue)

Description copied from interface: AdjacencyProperties

Create a new cursor for the properties of the relationships of a given node. If the cursor cannot produce property values, it will yield the provided fallbackValue. NOTE: Fallback behavior is not widely available and will be part of the next episode. Undefined behavior if the node does not exist.

Specified by:

propertyCursor in interface AdjacencyProperties

propertyCursor

public PropertyCursor propertyCursor(PropertyCursor reuse,
                                     long node,
                                     double fallbackValue)

Description copied from interface: AdjacencyProperties

Create a new cursor for the properties of the relationships of a given node. If the cursor cannot produce property values, it will yield the provided fallbackValue. NOTE: Fallback behavior is not widely available and will be part of the next episode. 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:

propertyCursor in interface AdjacencyProperties

rawPropertyCursor

public PropertyCursor rawPropertyCursor()

Description copied from interface: AdjacencyProperties

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

Specified by:

rawPropertyCursor in interface AdjacencyProperties