| Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 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, |
| 13 | * software distributed under the License is distributed on an |
| 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | * KIND, either express or implied. See the License for the |
| 16 | * specific language governing permissions and limitations |
| 17 | * under the License. |
| 18 | */ |
| tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 19 | package org.onlab.graph; |
| 20 | |
| 21 | /** |
| 22 | * Representation of a graph search algorithm and its outcome. |
| 23 | * |
| 24 | * @param <V> vertex type |
| 25 | * @param <E> edge type |
| 26 | */ |
| 27 | public interface GraphSearch<V extends Vertex, E extends Edge<V>> { |
| 28 | |
| 29 | /** |
| 30 | * Notion of a graph search result. |
| 31 | */ |
| 32 | public interface Result<V extends Vertex, E extends Edge<V>> { |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * Searches the specified graph. |
| 37 | * |
| 38 | * @param graph graph to be searched |
| 39 | * @param weight optional edge-weight; if null cost of each edge will be |
| 40 | * assumed to be 1.0 |
| 41 | * |
| 42 | * @return search results |
| 43 | */ |
| 44 | Result search(Graph<V, E> graph, EdgeWeight<V, E> weight); |
| 45 | |
| 46 | } |