Merge pull request #10552 from IoannisPanagiotas/small-ref-pgr

small ref

Author: IoannisPanagiotas

algo/src/main/java/org/neo4j/gds/pagerank/PageRankAlgorithm.java

@@ -24,13 +24,11 @@
 import org.neo4j.gds.api.properties.nodes.NodePropertyValuesAdapter;
 import org.neo4j.gds.beta.pregel.Pregel;
 import org.neo4j.gds.beta.pregel.PregelComputation;
-import org.neo4j.gds.core.concurrency.RunWithConcurrency;
-import org.neo4j.gds.termination.TerminationFlag;
 import org.neo4j.gds.collections.ha.HugeDoubleArray;
+import org.neo4j.gds.core.concurrency.RunWithConcurrency;
 import org.neo4j.gds.core.utils.partition.PartitionUtils;
 import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
-import org.neo4j.gds.scaling.L2Norm;
-import org.neo4j.gds.scaling.NoneScaler;
+import org.neo4j.gds.termination.TerminationFlag;
 
 import java.util.Optional;
 import java.util.concurrent.ExecutorService;
@@ -110,8 +108,7 @@ private void scaleScores(HugeDoubleArray scores) {
         var scalerFactory = config.scaler();
         var concurrency = config.concurrency();
 
-        // Eigenvector produces L2NORM-scaled results by default.
-        if (scalerFactory.type().equals(NoneScaler.TYPE) || (scalerFactory.type().equals(L2Norm.TYPE) && mode == PageRankVariant.EIGENVECTOR)) {
+        if (!scalerFactory.workingScaler() || mode.ignoreScaling(scalerFactory)) {
             return;
         }
 

algo/src/main/java/org/neo4j/gds/pagerank/PageRankVariant.java

@@ -19,18 +19,16 @@
  */
 package org.neo4j.gds.pagerank;
 
-public enum PageRankVariant {
-    PAGE_RANK("PageRank"),
-    ARTICLE_RANK("ArticleRank"),
-    EIGENVECTOR("EigenVector");
-
-    private final String taskName;
+import org.neo4j.gds.scaling.L2Norm;
+import org.neo4j.gds.scaling.ScalerFactory;
 
-    PageRankVariant(String taskName) {
-        this.taskName = taskName;
-    }
+public enum PageRankVariant {
+    PAGE_RANK,
+    ARTICLE_RANK,
+    EIGENVECTOR;
 
-    String taskName() {
-        return taskName;
+    boolean ignoreScaling(ScalerFactory scalerFactory){
+        // Eigenvector produces L2NORM-scaled results by default.
+        return this == EIGENVECTOR &&  scalerFactory.type().equals(L2Norm.TYPE);
     }
 }

algo/src/test/java/org/neo4j/gds/pagerank/PageRankVariantTest.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.pagerank;
+
+import org.junit.jupiter.api.Test;
+import org.neo4j.gds.scaling.ScalerFactory;
+
+import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
+
+class PageRankVariantTest {
+
+    @Test
+    void shouldNotIgnoreScaling(){
+        assertThat(PageRankVariant.PAGE_RANK.ignoreScaling(ScalerFactory.parse("max"))).isFalse();
+        assertThat(PageRankVariant.PAGE_RANK.ignoreScaling(ScalerFactory.parse("l2norm"))).isFalse();
+        assertThat(PageRankVariant.ARTICLE_RANK.ignoreScaling(ScalerFactory.parse("max"))).isFalse();
+        assertThat(PageRankVariant.ARTICLE_RANK.ignoreScaling(ScalerFactory.parse("l2norm"))).isFalse();
+        assertThat(PageRankVariant.EIGENVECTOR.ignoreScaling(ScalerFactory.parse("max"))).isFalse();
+    }
+    @Test
+    void shouldIgnoreScaling(){
+        assertThat(PageRankVariant.EIGENVECTOR.ignoreScaling(ScalerFactory.parse("l2norm"))).isTrue();
+    }
+
+}

scaling-utils/src/main/java/org/neo4j/gds/scaling/ScalerFactory.java

@@ -105,4 +105,8 @@ ScalarScaler create(
         ProgressTracker progressTracker,
         ExecutorService executor
     );
+
+    default boolean workingScaler(){
+        return !type().equals(NoneScaler.TYPE);
+    }
 }

scaling-utils/src/test/java/org/neo4j/gds/scaling/ScalerFactoryTest.java

@@ -71,4 +71,10 @@ void badInput() {
         assertThatThrownBy(() -> ScalerFactory.parse(Map.of("type", "log", "offset", false))).hasMessageContaining("The value of `offset` must be of type `Number` but was `Boolean`.");
         assertThatThrownBy(() -> ScalerFactory.parse(Map.of("type", "log", "offsat", 0))).hasMessageContaining("Unexpected configuration key: offsat");
     }
+
+    @Test
+    void shouldAcceptWorkingTypes(){
+        assertThat(ScalerFactory.parse("log").workingScaler()).isTrue();
+        assertThat(ScalerFactory.parse("none").workingScaler()).isFalse();
+    }
 }