Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 15 | */ |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 16 | package org.onlab.graph; |
| 17 | |
| 18 | /** |
| 19 | * Representation of a graph search algorithm and its outcome. |
| 20 | * |
| 21 | * @param <V> vertex type |
| 22 | * @param <E> edge type |
| 23 | */ |
| 24 | public interface GraphSearch<V extends Vertex, E extends Edge<V>> { |
| 25 | |
| 26 | /** |
| 27 | * Notion of a graph search result. |
| 28 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 29 | interface Result<V extends Vertex, E extends Edge<V>> { |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Searches the specified graph. |
| 34 | * |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 35 | * @param graph graph to be searched |
| 36 | * @param weigher optional edge-weigher; if null, {@link DefaultEdgeWeigher} |
| 37 | * will be used (assigns equal weights to all links) |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 38 | * |
| 39 | * @return search results |
| 40 | */ |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 41 | Result search(Graph<V, E> graph, EdgeWeigher<V, E> weigher); |
tom | e348941 | 2014-08-29 02:30:38 -0700 | [diff] [blame] | 42 | |
| 43 | } |