Add personalrank and neighborrank RESTful API

hugegraph-api/src/main/java/com/baidu/hugegraph/api/traversers/PersonalRankAPI.java

@@ -58,13 +58,10 @@ public class PersonalRankAPI extends API {
     public String personalRank(@Context GraphManager manager,
                                @PathParam("graph") String graph,
                                RankRequest request) {
-        LOG.debug("Graph [{}] get personal rank from '{}' with " +
-                  "edge label '{}', alpha '{}', max depth '{}'",
-                  graph, request.source, request.label,
-                  request.alpha, request.maxDepth);
-
-        E.checkNotNull(request.source, "source vertex id");
-        E.checkNotNull(request.label, "edge label");
+        E.checkArgument(request.source != null,
+                        "The source vertex id of rank request can't be null");
+        E.checkArgument(request.label != null,
+                        "The edge label of rank request can't be null");
         E.checkArgument(request.alpha > 0 && request.alpha <= 1.0,
                         "The alpha of rank request must belong (0, 1], " +
                         "but got '%s'", request.alpha);
@@ -75,6 +72,12 @@ public String personalRank(@Context GraphManager manager,
                         "The max depth of rank request must >= 1, but got '%s'",
                         request.maxDepth);
 
+        LOG.debug("Graph [{}] get personal rank from '{}' with " +
+                  "edge label '{}', alpha '{}', degree '{}', " +
+                  "max depth '{}', sorted '{}'",
+                  graph, request.source, request.label, request.alpha,
+                  request.degree, request.maxDepth, request.sorted);
+
         Id sourceId = VertexAPI.checkAndParseVertexId(request.source);
         HugeGraph g = graph(manager, graph);
 

hugegraph-core/pom.xml

@@ -19,7 +19,7 @@
         <dependency>
             <groupId>com.baidu.hugegraph</groupId>
             <artifactId>hugegraph-common</artifactId>
-            <version>1.5.8</version>
+            <version>1.6.0</version>
         </dependency>
 
         <!-- tinkerpop -->

hugegraph-core/src/main/java/com/baidu/hugegraph/traversal/algorithm/NeighborRankTraverser.java

@@ -38,7 +38,6 @@
 import com.baidu.hugegraph.util.E;
 import com.baidu.hugegraph.util.OrderLimitMap;
 import com.google.common.collect.ImmutableList;
-import com.google.common.collect.ImmutableMap;
 
 public class NeighborRankTraverser extends HugeTraverser {
 
@@ -66,8 +65,8 @@ public List<Map<Id, Double>> neighborRank(Id source, List<Step> steps) {
         boolean sameLayerTransfer = true;
         long access = 0;
         // Result
-        List<Map<Id, Double>> ranks = new ArrayList<>();
-        ranks.add(ImmutableMap.of(source, 1.0));
+        List<Ranks> ranks = new ArrayList<>();
+        ranks.add(Ranks.of(source, 1.0));
 
         root : for (Step step : steps) {
             Map<Id, Double> lastLayerRanks = ranks.get(ranks.size() - 1);
@@ -132,7 +131,7 @@ public List<Map<Id, Double>> neighborRank(Id source, List<Step> steps) {
                 this.contributePrevLayers(ranks, incr, prevLayerNodesV);
             }
 
-            Map<Id, Double> newLayerRanks;
+            Ranks newLayerRanks;
             if (sameLayerTransfer) {
                 // First contribute to last layer, then pass to the new layer
                 this.contributeLastLayer(sameLayerIncrRanks, lastLayerRanks);
@@ -164,13 +163,12 @@ private boolean belongToSameLayer(Set<Id> sources, Id target,
         }
     }
 
-    private boolean belongToPrevLayers(List<Map<Id, Double>> ranks, Id target,
+    private boolean belongToPrevLayers(List<Ranks> ranks, Id target,
                                        Map<Integer, Set<Id>> prevLayerNodes) {
         for (int i = ranks.size() - 2; i > 0; i--) {
-            Map<Id, Double> prevLayerRanks = ranks.get(i);
+            Ranks prevLayerRanks = ranks.get(i);
             if (prevLayerRanks.containsKey(target)) {
-                Set<Id> nodes = prevLayerNodes.computeIfAbsent(i,
-                                               k -> new HashSet<>());
+                Set<Id> nodes = prevLayerNodes.computeIfAbsent(i, HashSet::new);
                 nodes.add(target);
                 return true;
             }
@@ -186,7 +184,7 @@ private void mergeSameLayerIncrRanks(Set<Id> sameLayerNodesV, double incr,
         }
     }
 
-    private void contributePrevLayers(List<Map<Id, Double>> ranks, double incr,
+    private void contributePrevLayers(List<Ranks> ranks, double incr,
                                       Map<Integer, Set<Id>> prevLayerNodesV) {
         for (Map.Entry<Integer, Set<Id>> e : prevLayerNodesV.entrySet()) {
             Map<Id, Double> prevLayerRanks = ranks.get(e.getKey());
@@ -206,11 +204,10 @@ private void contributeLastLayer(Map<Id, Double> rankIncrs,
         }
     }
 
-    private Map<Id, Double> contributeNewLayer(
-                            MultivaluedMap<Id, Node> adjacencies,
-                            Map<Id, Double> lastLayerRanks,
-                            int capacity) {
-        Map<Id, Double> newLayerRanks = new OrderLimitMap<>(capacity);
+    private Ranks contributeNewLayer(MultivaluedMap<Id, Node> adjacencies,
+                                     Map<Id, Double> lastLayerRanks,
+                                     int capacity) {
+        Ranks newLayerRanks = new Ranks(capacity);
         for (Map.Entry<Id, List<Node>> entry : adjacencies.entrySet()) {
             Id parent = entry.getKey();
             long size = entry.getValue().size();
@@ -223,16 +220,15 @@ private Map<Id, Double> contributeNewLayer(
         return newLayerRanks;
     }
 
-    private List<Map<Id, Double>> topRanks(List<Map<Id, Double>> ranks,
+    private List<Map<Id, Double>> topRanks(List<Ranks> ranks,
                                            List<Step> steps) {
         assert ranks.size() > 0;
         List<Map<Id, Double>> results = new ArrayList<>(ranks.size());
         // The first layer is root node so skip i=0
         results.add(ranks.get(0));
         for (int i = 1; i < ranks.size(); i++) {
             Step step = steps.get(i - 1);
-            OrderLimitMap<Id, Double> origin = (OrderLimitMap<Id, Double>)
-                                               ranks.get(i);
+            Ranks origin = ranks.get(i);
             if (origin.size() > step.top) {
                 results.add(origin.topN(step.top));
             } else {
@@ -259,4 +255,17 @@ public Step(Directions direction, Map<Id, String> labels,
             this.capacity = DEFAULT_CAPACITY_PER_LAYER;
         }
     }
+
+    private static class Ranks extends OrderLimitMap<Id, Double> {
+
+        public Ranks(int capacity) {
+            super(capacity);
+        }
+
+        public static Ranks of(Id key, Double value) {
+            Ranks ranks = new Ranks(1);
+            ranks.put(key, value);
+            return ranks;
+        }
+    }
 }

hugegraph-core/src/main/java/com/baidu/hugegraph/traversal/algorithm/PersonalRankTraverser.java

@@ -55,11 +55,17 @@ public PersonalRankTraverser(HugeGraph graph, double alpha,
     }
 
     public Map<Id, Double> personalRank(Id source, String label) {
+        E.checkArgumentNotNull(source, "The source vertex id can't be null");
+        E.checkArgumentNotNull(label, "The edge label can't be null");
+
+        Map<Id, Double> ranks = new HashMap<>();
+        ranks.put(source, 1.0);
+
         Id labelId = this.graph().edgeLabel(label).id();
         Directions dir = this.getStartDirection(source, label);
         long degree = this.degreeOfVertex(source, dir, labelId);
         if (degree <= 0) {
-            return ImmutableMap.of(source, 1.0);
+            return ranks;
         }
 
         Set<Id> outSeeds = new HashSet<>();
@@ -70,9 +76,6 @@ public Map<Id, Double> personalRank(Id source, String label) {
             inSeeds.add(source);
         }
 
-        Map<Id, Double> ranks = new HashMap<>();
-        ranks.put(source, 1.0);
-
         for (long i = 0; i < this.maxDepth; i++) {
             Map<Id, Double> incrRanks = this.getIncrRanks(outSeeds, inSeeds,
                                                           labelId, ranks);

hugegraph-core/src/main/java/com/baidu/hugegraph/version/CoreVersion.java

@@ -39,7 +39,7 @@ public class CoreVersion {
 
     public static void check() {
         // Check version of hugegraph-common
-        VersionUtil.check(CommonVersion.VERSION, "1.5.0", "1.6",
+        VersionUtil.check(CommonVersion.VERSION, "1.6.0", "1.7",
                           CommonVersion.NAME);
     }
 }

hugegraph-test/src/main/java/com/baidu/hugegraph/unit/UnitTestSuite.java

@@ -47,7 +47,6 @@
     EdgeIdTest.class,
     AnalyzerTest.class,
     JsonUtilTest.class,
-    OrderLimitMapTest.class,
 
     RocksDBSessionsTest.class,
     RocksDBCountersTest.class