Package org.neo4j.gds.core.huge

Class UnionGraph

java.lang.Object

org.neo4j.gds.core.huge.UnionGraph

All Implemented Interfaces:

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

public final class UnionGraph
extends java.lang.Object
implements CSRGraph

Nested Class Summary

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

BatchNodeIterable.BitSetIdIterator, 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

Method Summary

Modifier and Type	Method	Description
java.util.Optional<NodeFilteredGraph>	asNodeFilteredGraph()	If this graph is created using a node label filter, this will return a NodeFilteredGraph that represents the node set used in this graph.
java.util.Set<org.neo4j.gds.NodeLabel>	availableNodeLabels()
java.util.Set<java.lang.String>	availableNodeProperties()
java.util.Collection<PrimitiveLongIterable>	batchIterables(long batchSize)
void	canRelease(boolean canRelease)
CSRGraph	concurrentCopy()
boolean	contains(long originalNodeId)	Returns true iff the Neo4j id 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)	O(n) !
void	forEachNode(java.util.function.LongPredicate consumer)	Iterate over each nodeId
void	forEachNodeLabel(long mappedNodeId, 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.
boolean	hasLabel(long mappedNodeId, org.neo4j.gds.NodeLabel label)
boolean	hasRelationshipProperty()
long	highestOriginalId()	The highest id that is mapped in this id mapping.
boolean	isMultiGraph()	Whether the graph is guaranteed to have no parallel relationships.
boolean	isNodeFilteredGraph()
long	nodeCount()	Number of mapped nodeIds.
long	nodeCount(org.neo4j.gds.NodeLabel nodeLabel)	Number of mapped nodeIds for a specific node label.
java.util.PrimitiveIterator.OfLong	nodeIterator()
java.util.PrimitiveIterator.OfLong	nodeIterator(java.util.Set<org.neo4j.gds.NodeLabel> labels)
java.util.List<org.neo4j.gds.NodeLabel>	nodeLabels(long mappedNodeId)
NodePropertyValues	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	nthTarget(long nodeId, int offset)	Get the n-th target node id for a given sourceNodeId.
static CSRGraph	of(java.util.List<? extends CSRGraph> graphs)
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
java.util.Map<org.neo4j.gds.RelationshipType,Relationships.Topology>	relationshipTopologies()
CompositeAdjacencyList	relationshipTopology()
Graph	relationshipTypeFilteredGraph(java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes)
void	releaseProperties()	Release only the properties associated with that graph.
void	releaseTopology()	Release only the topological data associated with that graph.
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.
org.neo4j.gds.api.schema.GraphSchema	schema()
java.util.stream.Stream<RelationshipCursor>	streamRelationships(long nodeId, double fallbackValue)
long	toMappedNodeId(long originalNodeId)	Maps an original node id to a mapped node id.
long	toOriginalNodeId(long mappedNodeId)	Returns the original node id for the given mapped node id.
long	toRootNodeId(long mappedNodeId)	Maps a filtered mapped node id to its root mapped node id.

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

isEmpty, release

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

safeToMappedNodeId, withFilteredLabels

Method Detail

of

public static CSRGraph of(java.util.List<? extends CSRGraph> graphs)

nodeCount

public long nodeCount()

Description copied from interface: IdMap

Number of mapped nodeIds.

Specified by:

nodeCount in interface IdMap

nodeCount

public long nodeCount(org.neo4j.gds.NodeLabel nodeLabel)

Description copied from interface: IdMap

Number of mapped nodeIds for a specific node label.

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

highestOriginalId

public long highestOriginalId()

Description copied from interface: IdMap

The highest id that is mapped in this id mapping.

The value is the upper bound of the original node id space.

Specified by:

highestOriginalId in interface IdMap

schema

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

Specified by:

schema in interface Graph

relationshipCount

public long relationshipCount()

Specified by:

relationshipCount in interface Graph

Returns:

returns the total number of relationships in the graph.

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.

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 java.util.PrimitiveIterator.OfLong nodeIterator()

Specified by:

nodeIterator in interface NodeIterator

nodeIterator

public java.util.PrimitiveIterator.OfLong nodeIterator(java.util.Set<org.neo4j.gds.NodeLabel> labels)

Specified by:

nodeIterator in interface NodeIterator

nodeProperties

public NodePropertyValues 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

Parameters:

propertyKey - the node property key

Returns:

the values associated with that key

availableNodeProperties

public java.util.Set<java.lang.String> availableNodeProperties()

Specified by:

availableNodeProperties in interface NodePropertyContainer

toMappedNodeId

public long toMappedNodeId(long originalNodeId)

Description copied from interface: PartialIdMap

Maps an original node id to a mapped node id. In case of nested id maps, the mapped node id is always in the space of the innermost mapping.

Specified by:

toMappedNodeId in interface PartialIdMap

Parameters:

originalNodeId - must be smaller or equal to the id returned by IdMap.highestOriginalId()

toOriginalNodeId

public long toOriginalNodeId(long mappedNodeId)

Description copied from interface: IdMap

Returns the original node id for the given mapped node id. The original node id is typically the Neo4j node id. This method is guaranteed to always return the Neo4j id, regardless of the given mapped node id refers to a filtered node id space or a regular / unfiltered node id space.

Specified by:

toOriginalNodeId in interface IdMap

toRootNodeId

public long toRootNodeId(long mappedNodeId)

Description copied from interface: IdMap

Maps a filtered mapped node id to its root mapped node id. This is necessary for nested (filtered) id mappings. If this mapping is a nested mapping, this method returns the root mapped 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 originalNodeId)

Description copied from interface: IdMap

Returns true iff the Neo4j id is mapped, otherwise false.

Specified by:

contains in interface IdMap

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

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

relationshipTopologies

public java.util.Map<org.neo4j.gds.RelationshipType,Relationships.Topology> relationshipTopologies()

Specified by:

relationshipTopologies in interface CSRGraph

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

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

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

streamRelationships

public java.util.stream.Stream<RelationshipCursor> streamRelationships(long nodeId,
                                                                       double fallbackValue)

Specified by:

streamRelationships in interface RelationshipIterator

relationshipTypeFilteredGraph

public Graph relationshipTypeFilteredGraph(java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes)

Specified by:

relationshipTypeFilteredGraph in interface Graph

degree

public int degree(long nodeId)

Specified by:

degree in interface Degrees

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

See Also:

Graph.isMultiGraph()

concurrentCopy

public CSRGraph concurrentCopy()

Specified by:

concurrentCopy in interface CSRGraph

Specified by:

concurrentCopy in interface Graph

Specified by:

concurrentCopy in interface RelationshipIterator

Returns:

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

asNodeFilteredGraph

public java.util.Optional<NodeFilteredGraph> asNodeFilteredGraph()

Description copied from interface: Graph

If this graph is created using a node label filter, this will return a NodeFilteredGraph that represents the node set used in this graph. Be aware that it is not guaranteed to contain all relationships of the graph. Otherwise, it will return an empty Optional.

Specified by:

asNodeFilteredGraph in interface Graph

exists

public boolean exists(long sourceNodeId,
                      long targetNodeId)

O(n) !

Specified by:

exists in interface RelationshipPredicate

nthTarget

public long nthTarget(long nodeId,
                      int offset)

Description copied from interface: Graph

Get the n-th target node id for a given sourceNodeId. The order of the targets is not defined and depends on the implementation of the graph, but it is consistent across separate calls to this method on the same graph. The sourceNodeId must be a node id existing in the graph. The offset parameter is 0-indexed and must be positive. If offset is greater than the number of targets for sourceNodeId, -1 is returned. It is undefined behavior if the sourceNodeId does not exist in the graph or the offset is negative.

Specified by:

nthTarget in interface Graph

offset - the n-th target to return. Must be positive.

Returns:

the target at the offset or -1 if there is no such target.

canRelease

public void canRelease(boolean canRelease)

Specified by:

canRelease in interface Graph

releaseTopology

public void releaseTopology()

Description copied from interface: Graph

Release only the topological data associated with that graph.

Specified by:

releaseTopology in interface Graph

releaseProperties

public void releaseProperties()

Description copied from interface: Graph

Release only the properties associated with that graph.

Specified by:

releaseProperties in interface Graph

hasRelationshipProperty

public boolean hasRelationshipProperty()

Specified by:

hasRelationshipProperty in interface Graph

isMultiGraph

public boolean isMultiGraph()

Description copied from interface: Graph

Whether the graph is guaranteed to have no parallel relationships. If this returns false it still may be parallel-free, but we do not know.

Specified by:

isMultiGraph in interface Graph

Returns:

true iff the graph has maximum one relationship between each pair of nodes.

relationshipTopology

public CompositeAdjacencyList relationshipTopology()

nodeLabels

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

Specified by:

nodeLabels in interface IdMap

forEachNodeLabel

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

Specified by:

forEachNodeLabel in interface IdMap

availableNodeLabels

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

Specified by:

availableNodeLabels in interface IdMap

hasLabel

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

Specified by:

hasLabel in interface IdMap

isNodeFilteredGraph

public boolean isNodeFilteredGraph()