/*
 * 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.onlab.graph;

/**
 * Representation of a graph search algorithm and its outcome.
 *
 * @param <V>    vertex type
 * @param <E>    edge type
 */
public interface GraphSearch<V extends Vertex, E extends Edge<V>> {

    /**
     * Notion of a graph search result.
     */
    public interface Result<V extends Vertex, E extends Edge<V>> {
    }

    /**
     * Searches the specified graph.
     *
     * @param graph  graph to be searched
     * @param weight optional edge-weight; if null cost of each edge will be
     *               assumed to be 1.0
     *
     * @return search results
     */
    Result search(Graph<V, E> graph, EdgeWeight<V, E> weight);

}