Leomrlin commented on code in PR #668: URL: https://github.com/apache/geaflow/pull/668#discussion_r2525817948
########## geaflow/geaflow-dsl/geaflow-dsl-plan/src/main/java/org/apache/geaflow/dsl/udf/graph/JaccardSimilarityAlgorithm.java: ########## @@ -0,0 +1,178 @@ +/* + * 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.geaflow.dsl.udf.graph; + +import org.apache.geaflow.common.tuple.Tuple; +import org.apache.geaflow.common.type.primitive.DoubleType; +import org.apache.geaflow.dsl.common.algo.AlgorithmRuntimeContext; +import org.apache.geaflow.dsl.common.algo.AlgorithmUserFunction; +import org.apache.geaflow.dsl.common.data.Row; +import org.apache.geaflow.dsl.common.data.RowEdge; +import org.apache.geaflow.dsl.common.data.RowVertex; +import org.apache.geaflow.dsl.common.data.impl.ObjectRow; +import org.apache.geaflow.dsl.common.function.Description; +import org.apache.geaflow.dsl.common.types.GraphSchema; +import org.apache.geaflow.dsl.common.types.StructType; +import org.apache.geaflow.dsl.common.types.TableField; +import org.apache.geaflow.dsl.common.util.TypeCastUtil; +import org.apache.geaflow.model.graph.edge.EdgeDirection; + +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +/** + * @author [email protected] + * @version JaccardSimilarity.java, v 0.1 2025年11月13 怀玙 + */ Review Comment: It is recommended not to add author comments, @author tags, or other personal identifiers in code files to prevent disputes over code ownership ########## geaflow/geaflow-dsl/geaflow-dsl-plan/src/main/java/org/apache/geaflow/dsl/udf/graph/JaccardSimilarityAlgorithm.java: ########## @@ -0,0 +1,178 @@ +/* + * 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.geaflow.dsl.udf.graph; + +import org.apache.geaflow.common.tuple.Tuple; +import org.apache.geaflow.common.type.primitive.DoubleType; +import org.apache.geaflow.dsl.common.algo.AlgorithmRuntimeContext; +import org.apache.geaflow.dsl.common.algo.AlgorithmUserFunction; +import org.apache.geaflow.dsl.common.data.Row; +import org.apache.geaflow.dsl.common.data.RowEdge; +import org.apache.geaflow.dsl.common.data.RowVertex; +import org.apache.geaflow.dsl.common.data.impl.ObjectRow; +import org.apache.geaflow.dsl.common.function.Description; +import org.apache.geaflow.dsl.common.types.GraphSchema; +import org.apache.geaflow.dsl.common.types.StructType; +import org.apache.geaflow.dsl.common.types.TableField; +import org.apache.geaflow.dsl.common.util.TypeCastUtil; +import org.apache.geaflow.model.graph.edge.EdgeDirection; + +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +/** + * @author [email protected] + * @version JaccardSimilarity.java, v 0.1 2025年11月13 怀玙 + */ +@Description(name = "jaccard_similarity", description = "built-in udga for Jaccard Similarity") +public class JaccardSimilarityAlgorithm implements AlgorithmUserFunction<Object, Object> { + + private static final String PREFIX = "EDGE_COUNT_"; + + private AlgorithmRuntimeContext<Object, Object> context; + + private Tuple<Object, Object> vertices; + + @Override + public void init(AlgorithmRuntimeContext<Object, Object> context, Object[] params) { + this.context = context; + + if (params.length != 2) { + throw new IllegalArgumentException("Only support two arguments, usage: common_neighbors(id_a, id_b)"); + } + this.vertices = new Tuple<>(TypeCastUtil.cast(params[0], context.getGraphSchema().getIdType()), + TypeCastUtil.cast(params[1], context.getGraphSchema().getIdType())); + } + + @Override + public void process(RowVertex vertex, Optional<Row> updatedValues, Iterator<Object> messages) { + // similarity = |A ∩ B| / |A ∪ B| = |A ∩ B| / ( |A| + |B| - |A ∩ B| ) + // so we can calculate |A ∩ B| , |A| and |B| to calculate similarity + + Object vertexId = vertex.getId(); + + // Iteration 1 & 2 : calculate |A ∩ B| + if (context.getCurrentIterationId() == 1L) { + // send message to neighbors if they are vertices in params + if (vertices.f0.equals(vertexId) || vertices.f1.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + sendMessageToNeighbors(edges, vertexId); + } + return; + } + if (context.getCurrentIterationId() == 2L) { + if (vertices.f0.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + long edgeCount = edges.size(); + // send neighbour count of A to B + context.sendMessage(vertices.f1, PREFIX + calculateDeduplicatedSize(edges, vertexId)); + } + + // add to result if received messages from both vertices in params + Tuple<Boolean, Boolean> received = new Tuple<>(false, false); + while (messages.hasNext()) { + Object message = messages.next(); + + if (vertices.f0.equals(message)) { + received.setF0(true); + } else if (vertices.f1.equals(message)) { + received.setF1(true); + } + + if (received.getF0() && received.getF1()) { + context.sendMessage(vertices.f1, message); Review Comment: You can use break here to exit the loop early ########## geaflow/geaflow-dsl/geaflow-dsl-plan/src/main/java/org/apache/geaflow/dsl/udf/graph/JaccardSimilarityAlgorithm.java: ########## @@ -0,0 +1,178 @@ +/* + * 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.geaflow.dsl.udf.graph; + +import org.apache.geaflow.common.tuple.Tuple; +import org.apache.geaflow.common.type.primitive.DoubleType; +import org.apache.geaflow.dsl.common.algo.AlgorithmRuntimeContext; +import org.apache.geaflow.dsl.common.algo.AlgorithmUserFunction; +import org.apache.geaflow.dsl.common.data.Row; +import org.apache.geaflow.dsl.common.data.RowEdge; +import org.apache.geaflow.dsl.common.data.RowVertex; +import org.apache.geaflow.dsl.common.data.impl.ObjectRow; +import org.apache.geaflow.dsl.common.function.Description; +import org.apache.geaflow.dsl.common.types.GraphSchema; +import org.apache.geaflow.dsl.common.types.StructType; +import org.apache.geaflow.dsl.common.types.TableField; +import org.apache.geaflow.dsl.common.util.TypeCastUtil; +import org.apache.geaflow.model.graph.edge.EdgeDirection; + +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +/** + * @author [email protected] + * @version JaccardSimilarity.java, v 0.1 2025年11月13 怀玙 + */ +@Description(name = "jaccard_similarity", description = "built-in udga for Jaccard Similarity") +public class JaccardSimilarityAlgorithm implements AlgorithmUserFunction<Object, Object> { + + private static final String PREFIX = "EDGE_COUNT_"; + + private AlgorithmRuntimeContext<Object, Object> context; + + private Tuple<Object, Object> vertices; + + @Override + public void init(AlgorithmRuntimeContext<Object, Object> context, Object[] params) { + this.context = context; + + if (params.length != 2) { + throw new IllegalArgumentException("Only support two arguments, usage: common_neighbors(id_a, id_b)"); + } + this.vertices = new Tuple<>(TypeCastUtil.cast(params[0], context.getGraphSchema().getIdType()), + TypeCastUtil.cast(params[1], context.getGraphSchema().getIdType())); + } + + @Override + public void process(RowVertex vertex, Optional<Row> updatedValues, Iterator<Object> messages) { + // similarity = |A ∩ B| / |A ∪ B| = |A ∩ B| / ( |A| + |B| - |A ∩ B| ) + // so we can calculate |A ∩ B| , |A| and |B| to calculate similarity + + Object vertexId = vertex.getId(); + + // Iteration 1 & 2 : calculate |A ∩ B| + if (context.getCurrentIterationId() == 1L) { + // send message to neighbors if they are vertices in params + if (vertices.f0.equals(vertexId) || vertices.f1.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + sendMessageToNeighbors(edges, vertexId); + } + return; + } + if (context.getCurrentIterationId() == 2L) { + if (vertices.f0.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + long edgeCount = edges.size(); + // send neighbour count of A to B + context.sendMessage(vertices.f1, PREFIX + calculateDeduplicatedSize(edges, vertexId)); + } + + // add to result if received messages from both vertices in params + Tuple<Boolean, Boolean> received = new Tuple<>(false, false); + while (messages.hasNext()) { + Object message = messages.next(); + + if (vertices.f0.equals(message)) { + received.setF0(true); + } else if (vertices.f1.equals(message)) { + received.setF1(true); + } + + if (received.getF0() && received.getF1()) { + context.sendMessage(vertices.f1, message); + } + } + } + + // Iteration 3 : calculate |A| + |B|, and use them to calculate similarity + if (context.getCurrentIterationId() == 3L) { + if (vertices.f1.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + // |A| + long neighborSum = calculateDeduplicatedSize(edges, vertexId); + Set<Object> set = new HashSet<>(); + + while (messages.hasNext()) { + Object message = messages.next(); + if (message instanceof String && ((String) message).startsWith(PREFIX)) { + // |A| + |B| + neighborSum += Long.parseLong(((String) message).substring(PREFIX.length())); Review Comment: The number of neighbors of A and B should be distinguished and not added together, because if both A and B have zero neighbors, the Jaccard similarity should still be 1.0. ########## geaflow/geaflow-dsl/geaflow-dsl-plan/src/main/java/org/apache/geaflow/dsl/udf/graph/JaccardSimilarityAlgorithm.java: ########## @@ -0,0 +1,178 @@ +/* + * 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.geaflow.dsl.udf.graph; + +import org.apache.geaflow.common.tuple.Tuple; +import org.apache.geaflow.common.type.primitive.DoubleType; +import org.apache.geaflow.dsl.common.algo.AlgorithmRuntimeContext; +import org.apache.geaflow.dsl.common.algo.AlgorithmUserFunction; +import org.apache.geaflow.dsl.common.data.Row; +import org.apache.geaflow.dsl.common.data.RowEdge; +import org.apache.geaflow.dsl.common.data.RowVertex; +import org.apache.geaflow.dsl.common.data.impl.ObjectRow; +import org.apache.geaflow.dsl.common.function.Description; +import org.apache.geaflow.dsl.common.types.GraphSchema; +import org.apache.geaflow.dsl.common.types.StructType; +import org.apache.geaflow.dsl.common.types.TableField; +import org.apache.geaflow.dsl.common.util.TypeCastUtil; +import org.apache.geaflow.model.graph.edge.EdgeDirection; + +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +/** + * @author [email protected] + * @version JaccardSimilarity.java, v 0.1 2025年11月13 怀玙 + */ +@Description(name = "jaccard_similarity", description = "built-in udga for Jaccard Similarity") +public class JaccardSimilarityAlgorithm implements AlgorithmUserFunction<Object, Object> { + + private static final String PREFIX = "EDGE_COUNT_"; + + private AlgorithmRuntimeContext<Object, Object> context; + + private Tuple<Object, Object> vertices; + + @Override + public void init(AlgorithmRuntimeContext<Object, Object> context, Object[] params) { + this.context = context; + + if (params.length != 2) { + throw new IllegalArgumentException("Only support two arguments, usage: common_neighbors(id_a, id_b)"); + } + this.vertices = new Tuple<>(TypeCastUtil.cast(params[0], context.getGraphSchema().getIdType()), + TypeCastUtil.cast(params[1], context.getGraphSchema().getIdType())); + } + + @Override + public void process(RowVertex vertex, Optional<Row> updatedValues, Iterator<Object> messages) { + // similarity = |A ∩ B| / |A ∪ B| = |A ∩ B| / ( |A| + |B| - |A ∩ B| ) + // so we can calculate |A ∩ B| , |A| and |B| to calculate similarity + + Object vertexId = vertex.getId(); + + // Iteration 1 & 2 : calculate |A ∩ B| + if (context.getCurrentIterationId() == 1L) { + // send message to neighbors if they are vertices in params + if (vertices.f0.equals(vertexId) || vertices.f1.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + sendMessageToNeighbors(edges, vertexId); + } + return; + } + if (context.getCurrentIterationId() == 2L) { + if (vertices.f0.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + long edgeCount = edges.size(); + // send neighbour count of A to B + context.sendMessage(vertices.f1, PREFIX + calculateDeduplicatedSize(edges, vertexId)); + } + + // add to result if received messages from both vertices in params + Tuple<Boolean, Boolean> received = new Tuple<>(false, false); + while (messages.hasNext()) { + Object message = messages.next(); + + if (vertices.f0.equals(message)) { + received.setF0(true); + } else if (vertices.f1.equals(message)) { + received.setF1(true); + } + + if (received.getF0() && received.getF1()) { + context.sendMessage(vertices.f1, message); + } + } + } + + // Iteration 3 : calculate |A| + |B|, and use them to calculate similarity + if (context.getCurrentIterationId() == 3L) { + if (vertices.f1.equals(vertexId)) { + List<RowEdge> edges = context.loadEdges(EdgeDirection.BOTH); + // |A| + long neighborSum = calculateDeduplicatedSize(edges, vertexId); + Set<Object> set = new HashSet<>(); + + while (messages.hasNext()) { + Object message = messages.next(); + if (message instanceof String && ((String) message).startsWith(PREFIX)) { + // |A| + |B| + neighborSum += Long.parseLong(((String) message).substring(PREFIX.length())); + } else { + set.add(vertexId); + } + } + + // |A ∩ B| + long commonNeighborCount = set.size(); + + double similarity = (double) commonNeighborCount / (neighborSum - commonNeighborCount); Review Comment: A division-by-zero guard is required -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
