util.graph

Class EdgeList<E extends DirectedEdge<?,E>>

java.lang.Object

util.graph.EdgeList<E>

Type Parameters:

E - the edge type of the graph

All Implemented Interfaces:

java.lang.Iterable<E>, Meldable<EdgeList<E>>

public final class EdgeList<E extends DirectedEdge<?,E>>
extends java.lang.Object
implements Meldable<EdgeList<E>>, java.lang.Iterable<E>

A linked list of edges for a graph that supports concatenation in O(1).

Constructor Summary

Constructors

Constructor and Description
EdgeList() Creates an empty EdgeList
EdgeList(java.lang.Iterable<? extends E> other) Takes another EdgeList an appends it to this one

Method Summary

Modifier and Type	Method and Description
void	append(E edge) Takes an edge and appends it to this EdgeList.
void	clear() Clears the EdgeList
<C extends java.util.Collection<E>> C	collect(java.util.function.Supplier<C> collectionFactory) Returns a new Collection of the elements of this EdgeList using the provided factory.
boolean	equals(java.lang.Object o) Checks if another object is equal to this EdgeList.
java.util.Iterator<E>	iterator() Returns an Iterator over the elements in this EdgeList.
<T extends DirectedEdge<?,T>> EdgeList<T>	map(java.util.function.Function<E,T> mapper) Transforms the elements of this EdgeList using the provided function.
<T,C extends java.util.Collection<T>> C	mapCollect(java.util.function.Function<E,T> mapper, java.util.function.Supplier<C> collectionFactory) Returns a new Collection of the elements of this EdgeList using the provided factory after transforming each element using the provided function.
void	meld(EdgeList<E> other) Destructively melds other into this.
void	prepend(E edge) Takes an edge and prepends it to this EdgeList.
int	size() Returns the number of edges in this EdgeList.
java.util.stream.Stream<E>	stream() Returns a Stream of the edges of this EdgeList.
E[]	toArray(java.util.function.IntFunction<E[]> generator) Creates an array of the edges of this EdgeList using the provided generator
java.lang.String	toString() Returns a string representation of this EdgeList.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EdgeList

public EdgeList()

Creates an empty EdgeList

EdgeList

public EdgeList(java.lang.Iterable<? extends E> other)

Takes another EdgeList an appends it to this one

Parameters:

other - the EdgeList to be appended

Method Detail

meld

public void meld(EdgeList<E> other)

Description copied from interface: Meldable

Destructively melds other into this.

Specified by:

meld in interface Meldable<EdgeList<E extends DirectedEdge<?,E>>>

Parameters:

other - the element to meld into this

size

public int size()

Returns the number of edges in this EdgeList.

Returns:

the number of edges in this EdgeList

append

public void append(E edge)

Takes an edge and appends it to this EdgeList.

Parameters:

edge - the edge to be appended to this EdgeList

prepend

public void prepend(E edge)

Takes an edge and prepends it to this EdgeList.

Parameters:

edge - the edge to be prepended to this EdgeList

clear

public void clear()

Clears the EdgeList

stream

public java.util.stream.Stream<E> stream()

Returns a Stream of the edges of this EdgeList.

Returns:

a Stream of the edges of this EdgeList

toArray

public E[] toArray(java.util.function.IntFunction<E[]> generator)

Creates an array of the edges of this EdgeList using the provided generator

Parameters:

generator - a function which produces a new array of the desired type and the provided length

Returns:

an array containing the edges of this EdgeList

collect

public <C extends java.util.Collection<E>> C collect(java.util.function.Supplier<C> collectionFactory)

Returns a new Collection of the elements of this EdgeList using the provided factory.

Type Parameters:

C - the type of the resulting Collection

Parameters:

collectionFactory - a Supplier which returns a new, empty Collection of the appropriate type

Returns:

a Collection of the elements of this EdgeList

mapCollect

public <T,C extends java.util.Collection<T>> C mapCollect(java.util.function.Function<E,T> mapper,
                                                          java.util.function.Supplier<C> collectionFactory)

Returns a new Collection of the elements of this EdgeList using the provided factory after transforming each element using the provided function.

Type Parameters:

T - the result type of the mapping function

C - the type of the resulting Collection

Parameters:

mapper - the mapping function

collectionFactory - a Supplier which returns a new, empty Collection of the appropriate type

Returns:

a Collection containing the mapped elements of this EdgeList

map

public <T extends DirectedEdge<?,T>> EdgeList<T> map(java.util.function.Function<E,T> mapper)

Transforms the elements of this EdgeList using the provided function.

Type Parameters:

T - the result type of the mapping function

Parameters:

mapper - the mapping function

Returns:

a new EdgeList containing the mapped elements of this EdgeList

toString

public java.lang.String toString()

Returns a string representation of this EdgeList.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this EdgeList.

equals

public boolean equals(java.lang.Object o)

Checks if another object is equal to this EdgeList. Two instances of EdgeList are equal iff they have the same size and contain the same elements in identical order.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to be tested for equality

Returns:

true if the argument is equal to this EdgeList.

iterator

public java.util.Iterator<E> iterator()

Returns an Iterator over the elements in this EdgeList.

Specified by:

iterator in interface java.lang.Iterable<E extends DirectedEdge<?,E>>

Returns:

an Iterator over the elements in this EdgeList.