Merge pull request #6564 from DarthMax/orientation_to_is_undirected

Replace orientation with direction

Author: DarthMax

algo/src/main/java/org/neo4j/gds/embeddings/graphsage/GraphSageHelper.java

@@ -276,10 +276,9 @@ public static HugeObjectArray<double[]> initializeMultiLabelFeatures(
     private static Map<NodeLabel, Set<String>> propertyKeysPerNodeLabel(GraphSchema graphSchema) {
         return graphSchema
             .nodeSchema()
-            .properties()
-            .entrySet()
+            .entries()
             .stream()
-            .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().keySet()));
+            .collect(Collectors.toMap(e -> e.identifier, e -> e.properties().keySet()));
     }
 
     private static Map<NodeLabel, Set<String>> filteredPropertyKeysPerNodeLabel(Graph graph, GraphSageTrainConfig config) {

algo/src/main/java/org/neo4j/gds/leiden/GraphAggregationPhase.java

@@ -27,6 +27,7 @@
 import org.neo4j.gds.api.DefaultValue;
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.IdMap;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.core.Aggregation;
 import org.neo4j.gds.core.ImmutableGraphDimensions;
 import org.neo4j.gds.core.concurrency.ParallelUtil;
@@ -98,7 +99,7 @@ static MemoryEstimation memoryEstimation() {
 
     private final Graph workingGraph;
     private final HugeLongArray communities;
-    private final Orientation orientation;
+    private final Direction direction;
     private final long maxCommunityId;
     private final ExecutorService executorService;
     private final int concurrency;
@@ -107,7 +108,7 @@ static MemoryEstimation memoryEstimation() {
 
     GraphAggregationPhase(
         Graph workingGraph,
-        Orientation orientation,
+        Direction direction,
         HugeLongArray communities,
         long maxCommunityId,
         ExecutorService executorService,
@@ -117,7 +118,7 @@ static MemoryEstimation memoryEstimation() {
     ) {
         this.workingGraph = workingGraph;
         this.communities = communities;
-        this.orientation = orientation;
+        this.direction = direction;
         this.maxCommunityId = maxCommunityId;
         this.executorService = executorService;
         this.concurrency = concurrency;
@@ -147,7 +148,7 @@ Graph run() {
         IdMap idMap = nodesBuilder.build().idMap();
         RelationshipsBuilder relationshipsBuilder = GraphFactory.initRelationshipsBuilder()
             .nodes(idMap)
-            .orientation(orientation)
+            .orientation(direction.toOrientation())
             .addPropertyConfig(Aggregation.SUM, DefaultValue.forDouble())
             .executorService(executorService)
             .build();
@@ -169,7 +170,7 @@ Graph run() {
                     partition,
                     relationshipsBuilder,
                     workingGraph.concurrentCopy(),
-                    orientation,
+                    direction,
                     progressTracker
                 ),
             Optional.empty(),

algo/src/main/java/org/neo4j/gds/leiden/Leiden.java

@@ -22,9 +22,9 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.neo4j.gds.Algorithm;
-import org.neo4j.gds.Orientation;
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.properties.nodes.NodePropertyValues;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.concurrency.RunWithConcurrency;
 import org.neo4j.gds.core.utils.paged.HugeDoubleArray;
@@ -42,7 +42,7 @@
 public class Leiden extends Algorithm<LeidenResult> {
 
     private final Graph rootGraph;
-    private final Orientation orientation;
+    private final Direction direction;
     private final int maxIterations;
     private final double initialGamma;
     private final double theta;
@@ -71,7 +71,7 @@ public Leiden(
     ) {
         super(progressTracker);
         this.rootGraph = graph;
-        this.orientation = rootGraph.schema().isUndirected() ? Orientation.UNDIRECTED : Orientation.NATURAL;
+        this.direction = rootGraph.schema().direction();
         this.maxIterations = maxIterations;
         this.initialGamma = initialGamma;
         this.theta = theta;
@@ -209,7 +209,7 @@ public LeidenResult compute() {
                 // 3 CREATE NEW GRAPH
                 var graphAggregationPhase = new GraphAggregationPhase(
                     workingGraph,
-                    this.orientation,
+                    this.direction,
                     refinedCommunities,
                     maximumRefinedCommunityId,
                     this.executorService,

algo/src/main/java/org/neo4j/gds/leiden/RelationshipCreator.java

@@ -19,8 +19,8 @@
  */
 package org.neo4j.gds.leiden;
 
-import org.neo4j.gds.Orientation;
 import org.neo4j.gds.api.RelationshipIterator;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.core.loading.construction.RelationshipsBuilder;
 import org.neo4j.gds.core.utils.paged.HugeDoubleArray;
 import org.neo4j.gds.core.utils.paged.HugeLongArray;
@@ -29,7 +29,7 @@
 
 final class RelationshipCreator implements Runnable {
 
-    private final Orientation orientation;
+    private final Direction direction;
     private final RelationshipsBuilder relationshipsBuilder;
     private final HugeLongArray communities;
     private final RelationshipIterator relationshipIterator;
@@ -46,10 +46,10 @@ final class RelationshipCreator implements Runnable {
         Partition partition,
         RelationshipsBuilder relationshipsBuilder,
         RelationshipIterator relationshipIterator,
-        Orientation orientation,
+        Direction direction,
         ProgressTracker progressTracker
     ) {
-        this.orientation = orientation;
+        this.direction = direction;
         this.relationshipsBuilder = relationshipsBuilder;
         this.communities = communities;
         this.relationshipIterator = relationshipIterator;
@@ -96,7 +96,7 @@ public void run() {
                     // hence we should add it as we encounter it from a
                     //otherwise  a<-[weight]->b will be visited from both a and b.
                     // To not include it twice we break a tie based on id.
-                    if (orientation == Orientation.NATURAL || currentCommunity > targetCommunityId) {
+                    if (direction == Direction.DIRECTED || currentCommunity > targetCommunityId) {
                         double valueToAdd = property;
                         if (encounteredCommunityWeights.get(targetCommunityId) == -1) {
                             encounteredCommunities.set(encountereCommunitiesCounter++, targetCommunityId);

algo/src/main/java/org/neo4j/gds/louvain/Louvain.java

@@ -20,7 +20,6 @@
 package org.neo4j.gds.louvain;
 
 import org.neo4j.gds.Algorithm;
-import org.neo4j.gds.Orientation;
 import org.neo4j.gds.api.DefaultValue;
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.IdMap;
@@ -235,11 +234,10 @@ private Graph summarizeGraph(
         if (workingGraph.schema().isUndirected()) {
             scaleCoefficient /= 2.0;
         }
-        Orientation orientation = rootGraph.schema().isUndirected() ? Orientation.UNDIRECTED : Orientation.NATURAL;
         IdMap idMap = nodesBuilder.build().idMap();
         RelationshipsBuilder relationshipsBuilder = GraphFactory.initRelationshipsBuilder()
             .nodes(idMap)
-            .orientation(orientation)
+            .orientation(rootGraph.schema().direction().toOrientation())
             .addPropertyConfig(Aggregation.SUM, DefaultValue.forDouble())
             .executorService(executorService)
             .build();

algo/src/main/java/org/neo4j/gds/similarity/SimilarityGraphResult.java

@@ -19,8 +19,8 @@
  */
 package org.neo4j.gds.similarity;
 
-import org.neo4j.gds.Orientation;
 import org.neo4j.gds.api.Graph;
+import org.neo4j.gds.api.schema.Direction;
 
 public class SimilarityGraphResult {
     private final Graph similarityGraph;
@@ -37,11 +37,10 @@ public Graph similarityGraph() {
         return similarityGraph;
     }
 
-    public Orientation orientation() {
+    public Direction direction() {
         return similarityGraph
             .schema()
-            .relationshipSchema()
-            .isUndirected() ? Orientation.UNDIRECTED : Orientation.NATURAL;
+            .direction();
     }
 
     public long comparedNodes() {

algo/src/test/java/org/neo4j/gds/beta/k1coloring/K1ColoringTest.java

@@ -21,9 +21,9 @@
 
 import org.apache.commons.lang3.mutable.MutableLong;
 import org.junit.jupiter.api.Test;
-import org.neo4j.gds.Orientation;
 import org.neo4j.gds.TestProgressTracker;
 import org.neo4j.gds.api.Graph;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.beta.generator.RandomGraphGenerator;
 import org.neo4j.gds.beta.generator.RelationshipDistribution;
 import org.neo4j.gds.compat.Neo4jProxy;
@@ -33,13 +33,11 @@
 import org.neo4j.gds.core.GraphDimensions;
 import org.neo4j.gds.core.ImmutableGraphDimensions;
 import org.neo4j.gds.core.concurrency.Pools;
-import org.neo4j.gds.core.huge.UnionGraph;
 import org.neo4j.gds.core.utils.mem.MemoryRange;
 import org.neo4j.gds.core.utils.paged.HugeLongArray;
 import org.neo4j.gds.core.utils.progress.EmptyTaskRegistryFactory;
 import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
 
-import java.util.Arrays;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -92,26 +90,16 @@ void testK1Coloring() {
     void testParallelK1Coloring() {
         long seed = 42L;
 
-        RandomGraphGenerator outGenerator = RandomGraphGenerator.builder()
-            .nodeCount(100_000)
-            .averageDegree(5)
-            .relationshipDistribution(RelationshipDistribution.POWER_LAW)
-            .seed(seed)
-            .build();
-
-        RandomGraphGenerator inGenerator = RandomGraphGenerator.builder()
-            .nodeCount(100_000)
-            .averageDegree(5)
+        var graph = RandomGraphGenerator.builder()
+            .nodeCount(200_000)
+            .averageDegree(10)
             .relationshipDistribution(RelationshipDistribution.POWER_LAW)
             .seed(seed)
             .aggregation(Aggregation.NONE)
-            .orientation(Orientation.REVERSE)
+            .direction(Direction.UNDIRECTED)
             .allowSelfLoops(AllowSelfLoops.NO)
-            .build();
-
-        var naturalGraph = outGenerator.generate();
-        var reverseGraph = inGenerator.generate();
-        var graph = UnionGraph.of(Arrays.asList(naturalGraph, reverseGraph));
+            .build()
+            .generate();
 
         K1Coloring k1Coloring = new K1Coloring(
             graph,

algo/src/test/java/org/neo4j/gds/beta/walking/CollapsePathTest.java

@@ -26,6 +26,7 @@
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.GraphStore;
 import org.neo4j.gds.api.Relationships;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
 import org.neo4j.gds.extension.GdlExtension;
@@ -160,7 +161,7 @@ private void assertResultGraph(GraphStore graphStore, Relationships relationship
             RelationshipType.of("SAME_DRUG"),
             Optional.empty(),
             Optional.empty(),
-            Orientation.NATURAL,
+            Direction.DIRECTED,
             relationships
         );
 
@@ -201,7 +202,7 @@ void shouldComputeForAllNodesWithoutNodeLabelsSpecified() {
             var relationships = new CollapsePathAlgorithmFactory()
                 .build(graphStore, config, ProgressTracker.NULL_TRACKER)
                 .compute();
-            graphStore.addRelationshipType(mutateRelType, Optional.empty(), Optional.empty(), Orientation.NATURAL, relationships);
+            graphStore.addRelationshipType(mutateRelType, Optional.empty(), Optional.empty(), Direction.DIRECTED, relationships);
             var resultGraph = graphStore.getGraph(mutateRelType);
 
             // then two relationships should be created
@@ -226,7 +227,7 @@ void shouldComputeForSubsetOfNodesWithNodeLabelsSpecified() {
             var relationships = new CollapsePathAlgorithmFactory()
                 .build(graphStore, config, ProgressTracker.NULL_TRACKER)
                 .compute();
-            graphStore.addRelationshipType(mutateRelType, Optional.empty(), Optional.empty(), Orientation.NATURAL, relationships);
+            graphStore.addRelationshipType(mutateRelType, Optional.empty(), Optional.empty(), Direction.DIRECTED, relationships);
             var resultGraph = graphStore.getGraph(mutateRelType);
 
             // a single relationship is created (there is no Dog)

algo/src/test/java/org/neo4j/gds/embeddings/graphsage/GraphSageTest.java

@@ -28,6 +28,7 @@
 import org.neo4j.gds.api.DatabaseId;
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.GraphStore;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.beta.generator.PropertyProducer;
 import org.neo4j.gds.beta.generator.RandomGraphGenerator;
 import org.neo4j.gds.beta.generator.RelationshipDistribution;
@@ -105,7 +106,7 @@ void setUp() {
             .relationshipPropertyProducer(PropertyProducer.fixedDouble("weight", 1.0))
             .seed(123L)
             .aggregation(Aggregation.SINGLE)
-            .orientation(Orientation.UNDIRECTED)
+            .direction(Direction.UNDIRECTED)
             .allowSelfLoops(RandomGraphGeneratorConfig.AllowSelfLoops.NO)
             .build().generate();
 
@@ -189,7 +190,7 @@ void differentTrainAndPredictionGraph() {
             .relationshipDistribution(RelationshipDistribution.POWER_LAW)
             .relationshipPropertyProducer(PropertyProducer.fixedDouble("weight", 1.0))
             .aggregation(Aggregation.SINGLE)
-            .orientation(Orientation.UNDIRECTED)
+            .direction(Direction.UNDIRECTED)
             .allowSelfLoops(RandomGraphGeneratorConfig.AllowSelfLoops.NO)
             .build()
             .generate();

algo/src/test/java/org/neo4j/gds/leiden/GraphAggregationPhaseTest.java

@@ -21,6 +21,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.neo4j.gds.Orientation;
+import org.neo4j.gds.api.schema.Direction;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.utils.TerminationFlag;
 import org.neo4j.gds.core.utils.paged.HugeLongArray;
@@ -79,7 +80,7 @@ void testGraphAggregation() {
 
         var aggregationPhase = new GraphAggregationPhase(
             graph,
-            Orientation.UNDIRECTED,
+            Direction.UNDIRECTED,
             communities,
             1L,
             Pools.DEFAULT_SINGLE_THREAD_POOL,