-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(algorithm): support single source shortest path algorithm (#285)
Add single source shortest path algorithm. There are 3 types of `target vertex`: 1. single target: ```yaml single_source_shortest_path.source_id="\"A\"" single_source_shortest_path.target_id="\"E\"" ``` 2. multiple target: ```yaml single_source_shortest_path.source_id="\"A\"" single_source_shortest_path.target_id="\"E\", \"C\"" ``` 3. all target: ```yaml single_source_shortest_path.source_id="\"A\"" single_source_shortest_path.target_id=* ``` --------- Co-authored-by: imbajin <jin@apache.org>
- Loading branch information
1 parent
f64a608
commit 192ef3b
Showing
19 changed files
with
1,004 additions
and
5 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
...thm/src/main/java/org/apache/hugegraph/computer/algorithm/path/shortest/QuantityType.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with this | ||
* work for additional information regarding copyright ownership. The ASF | ||
* licenses this file to You under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.apache.hugegraph.computer.algorithm.path.shortest; | ||
|
||
public enum QuantityType { | ||
|
||
SINGLE, | ||
MULTIPLE, | ||
ALL | ||
} |
281 changes: 281 additions & 0 deletions
281
.../java/org/apache/hugegraph/computer/algorithm/path/shortest/SingleSourceShortestPath.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,281 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with this | ||
* work for additional information regarding copyright ownership. The ASF | ||
* licenses this file to You under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.apache.hugegraph.computer.algorithm.path.shortest; | ||
|
||
import java.util.Arrays; | ||
import java.util.Iterator; | ||
import java.util.stream.Collectors; | ||
|
||
import org.apache.commons.lang3.StringUtils; | ||
import org.apache.hugegraph.computer.core.common.exception.ComputerException; | ||
import org.apache.hugegraph.computer.core.config.Config; | ||
import org.apache.hugegraph.computer.core.graph.edge.Edge; | ||
import org.apache.hugegraph.computer.core.graph.id.Id; | ||
import org.apache.hugegraph.computer.core.graph.value.DoubleValue; | ||
import org.apache.hugegraph.computer.core.graph.value.IdSet; | ||
import org.apache.hugegraph.computer.core.graph.value.Value; | ||
import org.apache.hugegraph.computer.core.graph.vertex.Vertex; | ||
import org.apache.hugegraph.computer.core.util.IdUtil; | ||
import org.apache.hugegraph.computer.core.worker.Computation; | ||
import org.apache.hugegraph.computer.core.worker.ComputationContext; | ||
import org.apache.hugegraph.computer.core.worker.WorkerContext; | ||
import org.apache.hugegraph.util.Log; | ||
import org.slf4j.Logger; | ||
|
||
public class SingleSourceShortestPath implements Computation<SingleSourceShortestPathValue> { | ||
|
||
private static final Logger LOG = Log.logger(SingleSourceShortestPath.class); | ||
|
||
public static final String OPTION_SOURCE_ID = "single_source_shortest_path.source_id"; | ||
public static final String OPTION_TARGET_ID = "single_source_shortest_path.target_id"; | ||
public static final String OPTION_WEIGHT_PROPERTY = | ||
"single_source_shortest_path.weight_property"; | ||
public static final String OPTION_DEFAULT_WEIGHT = | ||
"single_source_shortest_path.default_weight"; | ||
|
||
/** | ||
* source vertex id. | ||
*/ | ||
private Id sourceId; | ||
|
||
/** | ||
* target vertex id. | ||
* 1. single target: A | ||
* 2. multiple target: A, B, C | ||
* 3. all: * | ||
*/ | ||
private IdSet targetIdSet; // empty when targetId is all | ||
/** | ||
* target quantity type | ||
*/ | ||
private QuantityType targetQuantityType; | ||
|
||
/** | ||
* weight property. | ||
* weight value must be a positive number. | ||
*/ | ||
private String weightProperty; | ||
|
||
/** | ||
* default weight. | ||
* default 1 | ||
*/ | ||
private Double defaultWeight; | ||
|
||
//****************** global data ******************// | ||
/** | ||
* reached targets | ||
*/ | ||
private IdSet reachedTargets; // empty when targetId is all | ||
|
||
@Override | ||
public String category() { | ||
return "path"; | ||
} | ||
|
||
@Override | ||
public String name() { | ||
return "single_source_shortest_path"; | ||
} | ||
|
||
@Override | ||
public void init(Config config) { | ||
String sourceIdStr = config.getString(OPTION_SOURCE_ID, ""); | ||
if (StringUtils.isBlank(sourceIdStr)) { | ||
throw new ComputerException("The param '%s' must not be blank", OPTION_SOURCE_ID); | ||
} | ||
this.sourceId = IdUtil.parseId(sourceIdStr); | ||
|
||
String targetIdStr = config.getString(OPTION_TARGET_ID, ""); | ||
if (StringUtils.isBlank(targetIdStr)) { | ||
throw new ComputerException("The param '%s' must not be blank", OPTION_TARGET_ID); | ||
} | ||
// remove spaces | ||
targetIdStr = Arrays.stream(targetIdStr.split(",")) | ||
.map(e -> e.trim()) | ||
.collect(Collectors.joining(",")); | ||
this.targetQuantityType = this.getQuantityType(targetIdStr); | ||
if (this.targetQuantityType != QuantityType.ALL) { | ||
this.targetIdSet = new IdSet(); | ||
for (String targetId : targetIdStr.split(",")) { | ||
targetIdSet.add(IdUtil.parseId(targetId)); | ||
} | ||
} | ||
|
||
this.weightProperty = config.getString(OPTION_WEIGHT_PROPERTY, ""); | ||
|
||
this.defaultWeight = config.getDouble(OPTION_DEFAULT_WEIGHT, 1); | ||
if (this.defaultWeight <= 0) { | ||
throw new ComputerException("The param '%s' must be greater than 0, " + | ||
"actual got '%s'", | ||
OPTION_DEFAULT_WEIGHT, this.defaultWeight); | ||
} | ||
} | ||
|
||
@Override | ||
public void compute0(ComputationContext context, Vertex vertex) { | ||
SingleSourceShortestPathValue value = new SingleSourceShortestPathValue(); | ||
value.unreachable(); | ||
vertex.value(value); | ||
|
||
// start from source vertex | ||
if (!this.sourceId.equals(vertex.id())) { | ||
vertex.inactivate(); | ||
return; | ||
} | ||
value.zeroDistance(); // source vertex | ||
|
||
// single target && source == target | ||
if (this.targetQuantityType == QuantityType.SINGLE && | ||
this.targetIdSet.contains(this.sourceId)) { | ||
LOG.debug("source vertex equals target vertex: {}", this.sourceId); | ||
vertex.inactivate(); | ||
return; | ||
} | ||
|
||
if (vertex.numEdges() <= 0) { | ||
// isolated vertex | ||
LOG.debug("The source vertex is isolated: {}", this.sourceId); | ||
vertex.inactivate(); | ||
return; | ||
} | ||
|
||
vertex.edges().forEach(edge -> { | ||
SingleSourceShortestPathValue message = new SingleSourceShortestPathValue(); | ||
message.addToPath(vertex, this.getEdgeWeight(edge)); | ||
|
||
context.sendMessage(edge.targetId(), message); | ||
}); | ||
|
||
vertex.inactivate(); | ||
} | ||
|
||
@Override | ||
public void compute(ComputationContext context, Vertex vertex, | ||
Iterator<SingleSourceShortestPathValue> messages) { | ||
if (this.isTarget(vertex) && !this.reachedTargets.contains(vertex.id())) { | ||
// reached targets | ||
this.reachedTargets.add(vertex.id()); | ||
} | ||
|
||
while (messages.hasNext()) { | ||
SingleSourceShortestPathValue message = messages.next(); | ||
SingleSourceShortestPathValue value = vertex.value(); | ||
|
||
if (message.totalWeight() < value.totalWeight()) { | ||
// find a shorter path | ||
value.shorterPath(vertex, message.path(), message.totalWeight()); | ||
} else { | ||
continue; | ||
} | ||
|
||
// target vertex finds all targets reached or nowhere to go | ||
if ((this.isTarget(vertex) && this.isAllTargetsReached(vertex)) || | ||
vertex.numEdges() <= 0) { | ||
continue; | ||
} | ||
|
||
vertex.edges().forEach(edge -> { | ||
SingleSourceShortestPathValue forwardMessage = new SingleSourceShortestPathValue(); | ||
forwardMessage.addToPath(value.path(), | ||
value.totalWeight() + this.getEdgeWeight(edge)); | ||
|
||
context.sendMessage(edge.targetId(), forwardMessage); | ||
}); | ||
} | ||
|
||
vertex.inactivate(); | ||
} | ||
|
||
@Override | ||
public void beforeSuperstep(WorkerContext context) { | ||
this.reachedTargets = context.aggregatedValue( | ||
SingleSourceShortestPathMaster.SINGLE_SOURCE_SHORTEST_PATH_REACHED_TARGETS); | ||
} | ||
|
||
@Override | ||
public void afterSuperstep(WorkerContext context) { | ||
context.aggregateValue( | ||
SingleSourceShortestPathMaster.SINGLE_SOURCE_SHORTEST_PATH_REACHED_TARGETS, | ||
this.reachedTargets); | ||
} | ||
|
||
/** | ||
* get quantityType by targetId | ||
*/ | ||
private QuantityType getQuantityType(String targetIdStr) { | ||
if (targetIdStr.equals("*")) { | ||
return QuantityType.ALL; | ||
} else if (targetIdStr.contains(",")) { | ||
return QuantityType.MULTIPLE; | ||
} else { | ||
return QuantityType.SINGLE; | ||
} | ||
} | ||
|
||
/** | ||
* get the weight of an edge by its weight property | ||
*/ | ||
private double getEdgeWeight(Edge edge) { | ||
double weight = this.defaultWeight; | ||
|
||
Value property = edge.property(this.weightProperty); | ||
if (property != null) { | ||
if (!property.isNumber()) { | ||
throw new ComputerException("The value of %s must be a numeric value, " + | ||
"actual got '%s'", | ||
this.weightProperty, property.string()); | ||
} | ||
|
||
weight = ((DoubleValue) property).doubleValue(); | ||
if (weight <= 0) { | ||
throw new ComputerException("The value of %s must be greater than 0, " + | ||
"actual got '%s'", | ||
this.weightProperty, property.string()); | ||
} | ||
} | ||
return weight; | ||
} | ||
|
||
/** | ||
* determine whether vertex is one of the target | ||
*/ | ||
private boolean isTarget(Vertex vertex) { | ||
return this.targetQuantityType != QuantityType.ALL && | ||
this.targetIdSet.contains(vertex.id()); | ||
} | ||
|
||
/** | ||
* determine whether all targets reached | ||
*/ | ||
private boolean isAllTargetsReached(Vertex vertex) { | ||
if (this.targetQuantityType == QuantityType.ALL) { | ||
return false; | ||
} | ||
|
||
if (this.targetIdSet.size() == this.reachedTargets.size()) { | ||
for (Id targetId : this.targetIdSet.value()) { | ||
if (!this.reachedTargets.contains(targetId)) { | ||
return false; | ||
} | ||
} | ||
return true; | ||
} | ||
return false; | ||
} | ||
} |
30 changes: 30 additions & 0 deletions
30
...g/apache/hugegraph/computer/algorithm/path/shortest/SingleSourceShortestPathCombiner.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with this | ||
* work for additional information regarding copyright ownership. The ASF | ||
* licenses this file to You under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.apache.hugegraph.computer.algorithm.path.shortest; | ||
|
||
import org.apache.hugegraph.computer.core.combiner.Combiner; | ||
|
||
public class SingleSourceShortestPathCombiner implements Combiner<SingleSourceShortestPathValue> { | ||
|
||
@Override | ||
public void combine(SingleSourceShortestPathValue v1, SingleSourceShortestPathValue v2, | ||
SingleSourceShortestPathValue result) { | ||
SingleSourceShortestPathValue shorter = v2.totalWeight() < v1.totalWeight() ? v2 : v1; | ||
result.copy(shorter); | ||
} | ||
} |
47 changes: 47 additions & 0 deletions
47
...org/apache/hugegraph/computer/algorithm/path/shortest/SingleSourceShortestPathMaster.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with this | ||
* work for additional information regarding copyright ownership. The ASF | ||
* licenses this file to You under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.apache.hugegraph.computer.algorithm.path.shortest; | ||
|
||
import org.apache.hugegraph.computer.core.combiner.IdSetMergeCombiner; | ||
import org.apache.hugegraph.computer.core.graph.value.ValueType; | ||
import org.apache.hugegraph.computer.core.master.MasterComputation; | ||
import org.apache.hugegraph.computer.core.master.MasterComputationContext; | ||
import org.apache.hugegraph.computer.core.master.MasterContext; | ||
|
||
public class SingleSourceShortestPathMaster implements MasterComputation { | ||
|
||
public static final String SINGLE_SOURCE_SHORTEST_PATH_REACHED_TARGETS = | ||
"single_source_shortest_path.reached_targets"; | ||
|
||
@Override | ||
public void init(MasterContext context) { | ||
context.registerAggregator(SINGLE_SOURCE_SHORTEST_PATH_REACHED_TARGETS, | ||
ValueType.ID_SET, | ||
IdSetMergeCombiner.class); | ||
} | ||
|
||
@Override | ||
public void close(MasterContext context) { | ||
// pass | ||
} | ||
|
||
@Override | ||
public boolean compute(MasterComputationContext context) { | ||
return true; | ||
} | ||
} |
Oops, something went wrong.