org.grouplens.grapht.graph

Class DAGEdge<V,E>

java.lang.Object

org.grouplens.grapht.graph.DAGEdge<V,E>

Type Parameters:

V - The type of node labels.

E - The type of edge labels.

All Implemented Interfaces:

Serializable

public class DAGEdge<V,E>
extends Object
implements Serializable

Edges in DAGs. These arise from building nodes with a DAGNodeBuilder.

Two edges are equal if they connect the same pair of nodes and have the same label.

Since:

0.7.0

Author:

GroupLens Research

See Also:

DAGNode, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static <V,E> DAGEdge<V,E>	create(DAGNode<V,E> head, DAGNode<V,E> tail, E label)
boolean	equals(Object o)
static <V,E> com.google.common.base.Function<DAGEdge<V,E>,DAGNode<V,E>>	extractHead()
static <V,E> com.google.common.base.Function<DAGEdge<V,E>,DAGNode<V,E>>	extractTail()
DAGNode<V,E>	getHead() Get the edge's head (starting node).
E	getLabel() Get the edge's label.
DAGNode<V,E>	getTail() Get the edge's tail (ending node).
int	hashCode()
static <V,E> com.google.common.base.Predicate<DAGEdge<V,E>>	headMatches(com.google.common.base.Predicate<? super DAGNode<V,E>> pred)
static <E> com.google.common.base.Predicate<DAGEdge<?,E>>	labelMatches(com.google.common.base.Predicate<? super E> pred)
static <V,E> com.google.common.base.Predicate<DAGEdge<V,E>>	tailMatches(com.google.common.base.Predicate<? super DAGNode<V,E>> pred)
String	toString()
static <V,E> com.google.common.base.Function<DAGEdge<V,E>,DAGEdge<V,E>>	transformNodes(com.google.common.base.Function<? super DAGNode<V,E>,? extends DAGNode<V,E>> func) Transform an edge.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <V,E> DAGEdge<V,E> create(DAGNode<V,E> head,
                        DAGNode<V,E> tail,
                        E label)

getHead

@Nonnull
public DAGNode<V,E> getHead()

Get the edge's head (starting node).

Returns:

The edge's head.

getTail

@Nonnull
public DAGNode<V,E> getTail()

Get the edge's tail (ending node).

Returns:

The edge's tail.

getLabel

@Nonnull
public E getLabel()

Get the edge's label.

Returns:

The edge's label.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

labelMatches

public static <E> com.google.common.base.Predicate<DAGEdge<?,E>> labelMatches(com.google.common.base.Predicate<? super E> pred)

tailMatches

public static <V,E> com.google.common.base.Predicate<DAGEdge<V,E>> tailMatches(com.google.common.base.Predicate<? super DAGNode<V,E>> pred)

extractTail

public static <V,E> com.google.common.base.Function<DAGEdge<V,E>,DAGNode<V,E>> extractTail()

headMatches

public static <V,E> com.google.common.base.Predicate<DAGEdge<V,E>> headMatches(com.google.common.base.Predicate<? super DAGNode<V,E>> pred)

extractHead

public static <V,E> com.google.common.base.Function<DAGEdge<V,E>,DAGNode<V,E>> extractHead()

transformNodes

public static <V,E> com.google.common.base.Function<DAGEdge<V,E>,DAGEdge<V,E>> transformNodes(com.google.common.base.Function<? super DAGNode<V,E>,? extends DAGNode<V,E>> func)

Transform an edge. This function does not further transform the nodes, so if the edge is known as the outgoing edge of a node, that won't be fixed. Mostly useful for bulk operations on a bunch of edges, if you have them lying around.

Type Parameters:

V - The type of vertices.

E - The type of edges.

Parameters:

func - The node transformation function. If this function returns null, that is treated as equivalent to the identity function.

Returns:

A function over edges.