1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 package org.apache.giraph.function.vertex; 19 20 import java.io.Serializable; 21 22 import org.apache.giraph.function.PairFunction; 23 import org.apache.giraph.graph.Vertex; 24 import org.apache.hadoop.io.Writable; 25 import org.apache.hadoop.io.WritableComparable; 26 27 /** 28 * Function: 29 * (vertex, F) -> T 30 * 31 * Determines an output value based on a vertex and an input value. 32 * 33 * @param <I> Vertex id type 34 * @param <V> Vertex value type 35 * @param <E> Edge value type 36 * @param <F> Argument type 37 * @param <T> Result type 38 */ 39 @SuppressWarnings("rawtypes") 40 public interface FunctionWithVertex<I extends WritableComparable, 41 V extends Writable, E extends Writable, F, T> 42 extends PairFunction<Vertex<I, V, E>, F, T>, Serializable { 43 /** 44 * Returns the result of applying this function to given 45 * {@code vertex} and {@code input}. 46 * 47 * The returned object may or may not be a new instance, 48 * depending on the implementation. 49 * 50 * @param vertex Vertex 51 * @param input Input 52 * @return result 53 */ 54 @Override 55 T apply(Vertex<I, V, E> vertex, F input); 56 }