uk.co.strangeskies.mathematics.graph

Interface Graph.Edges<V,E>

All Superinterfaces:

java.util.Collection<E>, java.lang.Iterable<E>, java.util.Set<E>

Enclosing interface:

Graph<V,E>

@ProviderType
public static interface Graph.Edges<V,E>
extends java.util.Set<E>

Method Summary

Modifier and Type	Method and Description
default boolean	add(java.util.Collection<? extends EdgeVertices<V>> edgeVertices)
default boolean	add(EdgeVertices<V>... edges)
E	add(EdgeVertices<V> edge)
default E	add(V from, V to)
java.util.Set<E>	between(EdgeVertices<V> vertices)
default java.util.Set<E>	between(V from, V to)
E	betweenUnique(EdgeVertices<V> vertices)
default E	betweenUnique(V from, V to) If there is exactly one edge between the provided vertices, this edge is returned.
<T> java.util.Map<E,T>	createMap()
<T> java.util.Map<E,T>	createMap(java.util.Map<? extends E,? extends T> edges)
java.util.Set<E>	createSet()
java.util.Set<E>	createSet(java.util.Collection<? extends E> edges)
java.util.Set<EdgeVertices<V>>	edgeVertices()
java.util.function.BiPredicate<? super E,? super E>	equality()
java.util.Set<E>	incidentTo(V vertex)
java.util.Set<E>	incidentToHead(V vertex)
java.util.Set<E>	incidentToTail(V vertex)
double	weight(E edge)

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

equality

java.util.function.BiPredicate<? super E,? super E> equality()

weight

double weight(E edge)

incidentTo

java.util.Set<E> incidentTo(V vertex)

incidentToHead

java.util.Set<E> incidentToHead(V vertex)

incidentToTail

java.util.Set<E> incidentToTail(V vertex)

between

default java.util.Set<E> between(V from,
                                 V to)

between

java.util.Set<E> between(EdgeVertices<V> vertices)

betweenUnique

default E betweenUnique(V from,
                        V to)

If there is exactly one edge between the provided vertices, this edge is returned. If there is no edge between the provided vertices, null is returned. If there are multiple edges between them, an exception is thrown.

Parameters:

from - The tail vertex of the edge

to - The head vertex of the edge

Returns:

The edge between the given head and tail, or null if no such edge exists.

betweenUnique

E betweenUnique(EdgeVertices<V> vertices)

add

default E add(V from,
              V to)

add

E add(EdgeVertices<V> edge)

add

default boolean add(EdgeVertices<V>... edges)

add

default boolean add(java.util.Collection<? extends EdgeVertices<V>> edgeVertices)

edgeVertices

java.util.Set<EdgeVertices<V>> edgeVertices()

createSet

java.util.Set<E> createSet()

createSet

java.util.Set<E> createSet(java.util.Collection<? extends E> edges)

createMap

<T> java.util.Map<E,T> createMap()

createMap

<T> java.util.Map<E,T> createMap(java.util.Map<? extends E,? extends T> edges)