gr.james.simplegraph.WeightedDirectedEdge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simple-graph Show documentation

Simple Graph is a graph interface for Java 6 that is designed to expose a very simple API to support working with graphs

The newest version!

package gr.james.simplegraph;

/**
 * Represents an edge of a {@link WeightedDirectedGraph}.
 * 
 * Memory Complexity: O(1)
 */
public interface WeightedDirectedEdge extends BaseEdge {
    /**
     * Returns the source vertex of this edge.
     * 

     * Complexity: O(1)
     *
     * @return the source vertex of this edge
     */
    int source();

    /**
     * Returns the target vertex of this edge.
     * 

     * Complexity: O(1)
     *
     * @return the target vertex of this edge
     */
    int target();

    /**
     * Returns the weight of this edge.
     * 
     * Complexity: O(1)
     *
     * @return the weight of this edge
     */
    double weight();

    /**
     * {@inheritDoc}
     *
     * @param obj {@inheritDoc}
     * @return {@inheritDoc}
     */
    @Override
    boolean equals(Object obj);

    /**
     * {@inheritDoc}
     *
     * @return {@inheritDoc}
     */
    @Override
    int hashCode();

    /**
     * {@inheritDoc}
     *
     * @return {@inheritDoc}
     */
    @Override
    String toString();
}