blob: e79b98a6183bf883f279dc2aeaba6bfb47e81c2b [file] [log] [blame]
Thomas Vachuska24c849c2014-10-27 09:53:05 -07001/*
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 */
tome3489412014-08-29 02:30:38 -070019package org.onlab.graph;
20
21import java.util.List;
22
23/**
24 * Representation of a path in a graph as a sequence of edges. Paths are
25 * assumed to be continuous, where adjacent edges must share a vertex.
26 *
27 * @param <V> vertex type
28 * @param <E> edge type
29 */
30public interface Path<V extends Vertex, E extends Edge<V>> extends Edge<V> {
31
32 /**
33 * Returns the list of edges comprising the path. Adjacent edges will
34 * share the same vertex, meaning that a source of one edge, will be the
35 * same as the destination of the prior edge.
36 *
37 * @return list of path edges
38 */
39 List<E> edges();
40
41 /**
42 * Returns the total cost of the path as a unit-less number.
43 *
44 * @return path cost as a unit-less number
45 */
46 double cost();
47
48}