Package org.neo4j.gds.core.loading

Class HugeIdMap

java.lang.Object

org.neo4j.gds.core.loading.HugeIdMap

All Implemented Interfaces:

BatchNodeIterable, IdMap, NodeIterator, PartialIdMap

public class HugeIdMap
extends java.lang.Object
implements IdMap

This is basically a long to int mapper. It sorts the id's in ascending order so its guaranteed that there is no ID greater then nextGraphId / capacity

Nested Class Summary

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

BatchNodeIterable.IdIterable, BatchNodeIterable.IdIterator

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

IdMap.NodeLabelConsumer

Field Summary

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

NOT_FOUND, START_NODE_ID

Constructor Summary

Constructors

Constructor	Description
HugeIdMap(HugeLongArray graphIds, org.neo4j.gds.collections.HugeSparseLongArray nodeToGraphIds, LabelInformation labelInformation, long nodeCount, long highestNeoId)	initialize the map with pre-built sub arrays

Method Summary

Modifier and Type	Method	Description
java.util.Set<org.neo4j.gds.NodeLabel>	availableNodeLabels()
java.util.Collection<PrimitiveLongIterable>	batchIterables(long batchSize)
boolean	contains(long nodeId)	Returns true iff the nodeId is mapped, otherwise false.
void	forEachNode(java.util.function.LongPredicate consumer)	Iterate over each nodeId
void	forEachNodeLabel(long nodeId, IdMap.NodeLabelConsumer consumer)
boolean	hasLabel(long nodeId, org.neo4j.gds.NodeLabel label)
long	highestNeoId()
static org.neo4j.gds.core.utils.mem.MemoryEstimation	memoryEstimation()
long	nodeCount()	Number of mapped nodeIds.
PrimitiveLongIterator	nodeIterator()
java.util.List<org.neo4j.gds.NodeLabel>	nodeLabels(long nodeId)
IdMap	rootIdMap()	Returns the original node mapping if the current node mapping is filtered, otherwise it returns itself.
java.util.OptionalLong	rootNodeCount()	Number of mapped node ids in the root mapping.
long	toMappedNodeId(long nodeId)	Map original nodeId to inner nodeId
long	toOriginalNodeId(long nodeId)	Map inner nodeId back to original nodeId
long	toRootNodeId(long nodeId)	Maps an internal id to its root internal node id.
HugeIdMap	withFilteredLabels(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels, int concurrency)

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.IdMap

safeToMappedNodeId

Constructor Detail

HugeIdMap

public HugeIdMap(HugeLongArray graphIds,
                 org.neo4j.gds.collections.HugeSparseLongArray nodeToGraphIds,
                 LabelInformation labelInformation,
                 long nodeCount,
                 long highestNeoId)

initialize the map with pre-built sub arrays

Method Detail

memoryEstimation

public static org.neo4j.gds.core.utils.mem.MemoryEstimation memoryEstimation()

toMappedNodeId

public long toMappedNodeId(long nodeId)

Description copied from interface: PartialIdMap

Map original nodeId to inner nodeId

Specified by:

toMappedNodeId in interface PartialIdMap

Parameters:

nodeId - must be smaller or equal to the id returned by IdMap.highestNeoId()

toOriginalNodeId

public long toOriginalNodeId(long nodeId)

Description copied from interface: IdMap

Map inner nodeId back to original nodeId

Specified by:

toOriginalNodeId in interface IdMap

toRootNodeId

public long toRootNodeId(long nodeId)

Description copied from interface: IdMap

Maps an internal id to its root internal node id. This is necessary for nested (filtered) id mappings. If this mapping is a nested mapping, this method returns the root node id of the parent mapping. For the root mapping this method returns the given node id.

Specified by:

toRootNodeId in interface IdMap

rootIdMap

public IdMap rootIdMap()

Description copied from interface: IdMap

Returns the original node mapping if the current node mapping is filtered, otherwise it returns itself.

Specified by:

rootIdMap in interface IdMap

contains

public boolean contains(long nodeId)

Description copied from interface: IdMap

Returns true iff the nodeId is mapped, otherwise false.

Specified by:

contains in interface IdMap

nodeCount

public long nodeCount()

Description copied from interface: IdMap

Number of mapped nodeIds.

Specified by:

nodeCount in interface IdMap

rootNodeCount

public java.util.OptionalLong rootNodeCount()

Description copied from interface: PartialIdMap

Number of mapped node ids in the root mapping. This is necessary for nested (filtered) id mappings.

Specified by:

rootNodeCount in interface PartialIdMap

highestNeoId

public long highestNeoId()

Specified by:

highestNeoId in interface IdMap

forEachNode

public void forEachNode(java.util.function.LongPredicate consumer)

Description copied from interface: NodeIterator

Iterate over each nodeId

Specified by:

forEachNode in interface NodeIterator

nodeIterator

public PrimitiveLongIterator nodeIterator()

Specified by:

nodeIterator in interface NodeIterator

batchIterables

public java.util.Collection<PrimitiveLongIterable> batchIterables(long batchSize)

Specified by:

batchIterables in interface BatchNodeIterable

Returns:

a collection of iterables over every node, partitioned by the given batch size.

availableNodeLabels

public java.util.Set<org.neo4j.gds.NodeLabel> availableNodeLabels()

Specified by:

availableNodeLabels in interface IdMap

nodeLabels

public java.util.List<org.neo4j.gds.NodeLabel> nodeLabels(long nodeId)

Specified by:

nodeLabels in interface IdMap

forEachNodeLabel

public void forEachNodeLabel(long nodeId,
                             IdMap.NodeLabelConsumer consumer)

Specified by:

forEachNodeLabel in interface IdMap

hasLabel

public boolean hasLabel(long nodeId,
                        org.neo4j.gds.NodeLabel label)

Specified by:

hasLabel in interface IdMap

withFilteredLabels

public HugeIdMap withFilteredLabels(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels,
                                    int concurrency)

Specified by:

withFilteredLabels in interface IdMap