Package org.neo4j.gds.core.huge

Class NodeFilteredGraph

java.lang.Object

org.neo4j.gds.api.GraphAdapter

org.neo4j.gds.api.CSRGraphAdapter

org.neo4j.gds.core.huge.NodeFilteredGraph

All Implemented Interfaces:

BatchNodeIterable, CSRGraph, Degrees, Graph, IdMap, NodeIterator, NodePropertyContainer, RelationshipIterator, RelationshipPredicate, RelationshipProperties

public class NodeFilteredGraph
extends CSRGraphAdapter

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 class org.neo4j.gds.api.CSRGraphAdapter

csrGraph

Fields inherited from class org.neo4j.gds.api.GraphAdapter

graph

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

NOT_FOUND, START_NODE_ID

Constructor Summary

Constructors

Constructor	Description
NodeFilteredGraph(CSRGraph originalGraph, IdMap filteredIdMap, AllocationTracker allocationTracker)
NodeFilteredGraph(CSRGraph originalGraph, IdMap filteredIdMap, HugeIntArray degreeCache)

Method Summary

Modifier and Type	Method	Description
java.util.Set<org.neo4j.gds.NodeLabel>	availableNodeLabels()
java.util.Collection<PrimitiveLongIterable>	batchIterables(long batchSize)
CSRGraph	concurrentCopy()
boolean	contains(long nodeId)	Returns true iff the nodeId is mapped, otherwise false.
int	degree(long nodeId)
int	degreeWithoutParallelRelationships(long nodeId)	Much slower than just degree() because it may have to look up all relationships.
boolean	exists(long sourceNodeId, long targetNodeId)
void	forEachNode(java.util.function.LongPredicate consumer)	Iterate over each nodeId
void	forEachNodeLabel(long nodeId, IdMap.NodeLabelConsumer consumer)
void	forEachRelationship(long nodeId, double fallbackValue, RelationshipWithPropertyConsumer consumer)	Calls the given consumer function for every relationship of a given node.
void	forEachRelationship(long nodeId, RelationshipConsumer consumer)	Calls the given consumer function for every relationship of a given node.
long	getIntermediateOriginalNodeId(long nodeId)
boolean	hasLabel(long nodeId, org.neo4j.gds.NodeLabel label)
long	highestNeoId()
IdMap	idMap()
long	nodeCount()	Number of mapped nodeIds.
PrimitiveLongIterator	nodeIterator()
java.util.Set<org.neo4j.gds.NodeLabel>	nodeLabels(long nodeId)
NodeProperties	nodeProperties(java.lang.String propertyKey)	Return the property values for a property key NOTE: Avoid using this on the hot path, favor caching the NodeProperties object when possible
long	relationshipCount()
double	relationshipProperty(long sourceNodeId, long targetNodeId)	Returns the property value for a relationship defined by its source and target nodes.
double	relationshipProperty(long sourceNodeId, long targetNodeId, double fallbackValue)	get value of property on relationship between source and target node id
long	rootNodeCount()	Number of mapped node ids in the root mapping.
org.neo4j.gds.api.schema.GraphSchema	schema()
long	toMappedNodeId(long neoNodeId)	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.

Methods inherited from class org.neo4j.gds.api.CSRGraphAdapter

relationshipTopologies

Methods inherited from class org.neo4j.gds.api.GraphAdapter

availableNodeProperties, canRelease, graph, hasRelationshipProperty, isMultiGraph, isUndirected, relationshipTypeFilteredGraph, release, releaseProperties, releaseTopology, rootIdMap, streamRelationships

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

canRelease, hasRelationshipProperty, isEmpty, isMultiGraph, isUndirected, relationshipTypeFilteredGraph, release, releaseProperties, releaseTopology

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

cloneIdMap, rootIdMap, safeToMappedNodeId, withFilteredLabels

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

availableNodeProperties

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

streamRelationships

Constructor Detail

NodeFilteredGraph

public NodeFilteredGraph(CSRGraph originalGraph,
                         IdMap filteredIdMap,
                         AllocationTracker allocationTracker)

NodeFilteredGraph

public NodeFilteredGraph(CSRGraph originalGraph,
                         IdMap filteredIdMap,
                         HugeIntArray degreeCache)

Method Detail

idMap

public IdMap idMap()

schema

public org.neo4j.gds.api.schema.GraphSchema schema()

Specified by:

schema in interface Graph

Overrides:

schema in class GraphAdapter

nodeIterator

public PrimitiveLongIterator nodeIterator()

Specified by:

nodeIterator in interface NodeIterator

Overrides:

nodeIterator in class GraphAdapter

batchIterables

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

Specified by:

batchIterables in interface BatchNodeIterable

Overrides:

batchIterables in class GraphAdapter

Returns:

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

forEachNode

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

Description copied from interface: NodeIterator

Iterate over each nodeId

Specified by:

forEachNode in interface NodeIterator

Overrides:

forEachNode in class GraphAdapter

degree

public int degree(long nodeId)

Specified by:

degree in interface Degrees

Overrides:

degree in class GraphAdapter

degreeWithoutParallelRelationships

public int degreeWithoutParallelRelationships(long nodeId)

Description copied from interface: Degrees

Much slower than just degree() because it may have to look up all relationships.

This is not thread-safe, so if this is called concurrently please use RelationshipIterator.concurrentCopy().

Specified by:

degreeWithoutParallelRelationships in interface Degrees

Overrides:

degreeWithoutParallelRelationships in class GraphAdapter

See Also:

Graph.isMultiGraph()

nodeCount

public long nodeCount()

Description copied from interface: IdMap

Number of mapped nodeIds.

Specified by:

nodeCount in interface IdMap

Overrides:

nodeCount in class GraphAdapter

rootNodeCount

public long rootNodeCount()

Description copied from interface: IdMap

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

Specified by:

rootNodeCount in interface IdMap

Overrides:

rootNodeCount in class GraphAdapter

relationshipCount

public long relationshipCount()

Specified by:

relationshipCount in interface Graph

Overrides:

relationshipCount in class GraphAdapter

Returns:

returns the total number of relationships in the graph.

highestNeoId

public long highestNeoId()

Specified by:

highestNeoId in interface IdMap

Overrides:

highestNeoId in class GraphAdapter

toMappedNodeId

public long toMappedNodeId(long neoNodeId)

Description copied from interface: IdMap

Map original nodeId to inner nodeId

Specified by:

toMappedNodeId in interface IdMap

Overrides:

toMappedNodeId in class GraphAdapter

Parameters:

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

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

Overrides:

toRootNodeId in class GraphAdapter

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

Overrides:

contains in class GraphAdapter

toOriginalNodeId

public long toOriginalNodeId(long nodeId)

Description copied from interface: IdMap

Map inner nodeId back to original nodeId

Specified by:

toOriginalNodeId in interface IdMap

Overrides:

toOriginalNodeId in class GraphAdapter

forEachRelationship

public void forEachRelationship(long nodeId,
                                RelationshipConsumer consumer)

Description copied from interface: RelationshipIterator

Calls the given consumer function for every relationship of a given node.

Specified by:

forEachRelationship in interface RelationshipIterator

Overrides:

forEachRelationship in class GraphAdapter

Parameters:

nodeId - id of the node for which to iterate relationships

consumer - relationship consumer function

forEachRelationship

public void forEachRelationship(long nodeId,
                                double fallbackValue,
                                RelationshipWithPropertyConsumer consumer)

Description copied from interface: RelationshipIterator

Calls the given consumer function for every relationship of a given node. If the graph was loaded with a relationship property, the property value of the relationship will be passed into the consumer. Otherwise the given fallback value will be used.

Specified by:

forEachRelationship in interface RelationshipIterator

Overrides:

forEachRelationship in class GraphAdapter

Parameters:

nodeId - id of the node for which to iterate relationships

fallbackValue - value used as relationship property if no properties were loaded

consumer - relationship consumer function

getIntermediateOriginalNodeId

public long getIntermediateOriginalNodeId(long nodeId)

exists

public boolean exists(long sourceNodeId,
                      long targetNodeId)

Specified by:

exists in interface RelationshipPredicate

Overrides:

exists in class GraphAdapter

relationshipProperty

public double relationshipProperty(long sourceNodeId,
                                   long targetNodeId,
                                   double fallbackValue)

Description copied from interface: RelationshipProperties

get value of property on relationship between source and target node id

Specified by:

relationshipProperty in interface RelationshipProperties

Overrides:

relationshipProperty in class GraphAdapter

Parameters:

sourceNodeId - source node

targetNodeId - target node

fallbackValue - value to use if relationship has no property value

Returns:

the property value

relationshipProperty

public double relationshipProperty(long sourceNodeId,
                                   long targetNodeId)

Description copied from interface: RelationshipProperties

Returns the property value for a relationship defined by its source and target nodes.

Specified by:

relationshipProperty in interface RelationshipProperties

Overrides:

relationshipProperty in class GraphAdapter

concurrentCopy

public CSRGraph concurrentCopy()

Specified by:

concurrentCopy in interface CSRGraph

Specified by:

concurrentCopy in interface Graph

Specified by:

concurrentCopy in interface RelationshipIterator

Overrides:

concurrentCopy in class CSRGraphAdapter

Returns:

a copy of this iterator that reuses new cursors internally, so that iterations happen independent from other iterations.

availableNodeLabels

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

Specified by:

availableNodeLabels in interface IdMap

Overrides:

availableNodeLabels in class GraphAdapter

nodeLabels

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

Specified by:

nodeLabels in interface IdMap

Overrides:

nodeLabels in class GraphAdapter

hasLabel

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

Specified by:

hasLabel in interface IdMap

Overrides:

hasLabel in class GraphAdapter

forEachNodeLabel

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

Specified by:

forEachNodeLabel in interface IdMap

Overrides:

forEachNodeLabel in class GraphAdapter

nodeProperties

public NodeProperties nodeProperties(java.lang.String propertyKey)

Description copied from interface: NodePropertyContainer

Return the property values for a property key NOTE: Avoid using this on the hot path, favor caching the NodeProperties object when possible

Specified by:

nodeProperties in interface NodePropertyContainer

Overrides:

nodeProperties in class GraphAdapter

Parameters:

propertyKey - the node property key

Returns:

the values associated with that key