io.ataraxic.nomicflux.voyageur.impl

Class ValueEdge<A,L,W>

Object

ValueEdge<A,L,W>

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

W - The type of the weight metadata on the edge

All Implemented Interfaces:

Edge<A,ValueNode<A,L>,ValueEdge<A,L,W>>, WeightedEdge<A,ValueNode<A,L>,W,ValueEdge<A,L,W>>

public final class ValueEdge<A,L,W>
extends Object
implements WeightedEdge<A,ValueNode<A,L>,W,ValueEdge<A,L,W>>

A WeightedEdge which is a value object, isomorphic to the two ValueNodes it connects and its weight.

Method Summary

Modifier and Type	Method and Description
static <A,L> Fn1<ValueNode<A,L>,ValueEdge<A,L,Unit>>	edgeFrom(ValueNode<A,L> from)
static <A,L> Fn2<ValueNode<A,L>,ValueNode<A,L>,ValueEdge<A,L,Unit>>	edgeFromTo()
static <A,L> ValueEdge<A,L,Unit>	edgeFromTo(ValueNode<A,L> from, ValueNode<A,L> to) Create an edge from one node to another, with no weight information
static <A,L> Fn1<ValueNode<A,L>,ValueEdge<A,L,Unit>>	edgeTo(ValueNode<A,L> to)
static <A,L> Fn2<ValueNode<A,L>,ValueNode<A,L>,ValueEdge<A,L,Unit>>	edgeToFrom()
static <A,L> ValueEdge<A,L,Unit>	edgeToFrom(ValueNode<A,L> to, ValueNode<A,L> from) Create an edge to one node from another, with no weight information
boolean	equals(Object o)
ValueNode<A,L>	getNodeFrom()
ValueNode<A,L>	getNodeTo()
W	getWeight()
int	hashCode()
ValueEdge<A,L,W>	swap()
String	toString()
static <A,L,W> Fn2<ValueNode<A,L>,W,ValueEdge<A,L,W>>	weightedEdgeFrom(ValueNode<A,L> from) Curried function creating an edge from a given node
static <A,L,W> Fn3<ValueNode<A,L>,ValueNode<A,L>,W,ValueEdge<A,L,W>>	weightedEdgeFromTo()
static <A,L,W> Fn1<W,ValueEdge<A,L,W>>	weightedEdgeFromTo(ValueNode<A,L> from, ValueNode<A,L> to)
static <A,L,W> ValueEdge<A,L,W>	weightedEdgeFromTo(ValueNode<A,L> from, ValueNode<A,L> to, W weight) Create an edge from one node to another with weight metadata
static <A,L,W> Fn2<ValueNode<A,L>,W,ValueEdge<A,L,W>>	weightedEdgeTo(ValueNode<A,L> to) Curried function creating an edge to a given node
static <A,L,W> Fn3<ValueNode<A,L>,ValueNode<A,L>,W,ValueEdge<A,L,W>>	weightedEdgeToFrom()
static <A,L,W> Fn1<W,ValueEdge<A,L,W>>	weightedEdgeToFrom(ValueNode<A,L> to, ValueNode<A,L> from)
static <A,L,W> ValueEdge<A,L,W>	weightedEdgeToFrom(ValueNode<A,L> to, ValueNode<A,L> from, W weight) Create an edge to one node from another with weight metadata

Methods inherited from class Object

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

Method Detail

edgeFromTo

public static <A,L> ValueEdge<A,L,Unit> edgeFromTo(ValueNode<A,L> from,
                                                   ValueNode<A,L> to)

Create an edge from one node to another, with no weight information

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

Parameters:

from - ValueNode the edge starts from

to - ValueNode the edge ends at

Returns:

An edge from from going to to

edgeFromTo

public static <A,L> Fn2<ValueNode<A,L>,ValueNode<A,L>,ValueEdge<A,L,Unit>> edgeFromTo()

edgeToFrom

public static <A,L> ValueEdge<A,L,Unit> edgeToFrom(ValueNode<A,L> to,
                                                   ValueNode<A,L> from)

Create an edge to one node from another, with no weight information

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

Parameters:

to - ValueNode the edge ends at

from - ValueNode the edge starts from

Returns:

An edge to to coming from from

edgeToFrom

public static <A,L> Fn2<ValueNode<A,L>,ValueNode<A,L>,ValueEdge<A,L,Unit>> edgeToFrom()

edgeTo

public static <A,L> Fn1<ValueNode<A,L>,ValueEdge<A,L,Unit>> edgeTo(ValueNode<A,L> to)

edgeFrom

public static <A,L> Fn1<ValueNode<A,L>,ValueEdge<A,L,Unit>> edgeFrom(ValueNode<A,L> from)

weightedEdgeFromTo

public static <A,L,W> ValueEdge<A,L,W> weightedEdgeFromTo(ValueNode<A,L> from,
                                                          ValueNode<A,L> to,
                                                          W weight)

Create an edge from one node to another with weight metadata

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

W - The type of the edge's weight metadata

Parameters:

from - ValueNode the edge starts from

to - ValueNode the edge ends at

weight - Weight metadata for the edge

Returns:

An edge from from going to to and with weight weight

weightedEdgeFromTo

public static <A,L,W> Fn1<W,ValueEdge<A,L,W>> weightedEdgeFromTo(ValueNode<A,L> from,
                                                                 ValueNode<A,L> to)

weightedEdgeFromTo

public static <A,L,W> Fn3<ValueNode<A,L>,ValueNode<A,L>,W,ValueEdge<A,L,W>> weightedEdgeFromTo()

weightedEdgeToFrom

public static <A,L,W> ValueEdge<A,L,W> weightedEdgeToFrom(ValueNode<A,L> to,
                                                          ValueNode<A,L> from,
                                                          W weight)

Create an edge to one node from another with weight metadata

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

W - The type of the edge's weight metadata

Parameters:

to - ValueNode the edge ends at

from - ValueNode the edge starts from

weight - Weight metadata for the edge

Returns:

An edge to to coming from from and with weight weight

weightedEdgeToFrom

public static <A,L,W> Fn1<W,ValueEdge<A,L,W>> weightedEdgeToFrom(ValueNode<A,L> to,
                                                                 ValueNode<A,L> from)

weightedEdgeToFrom

public static <A,L,W> Fn3<ValueNode<A,L>,ValueNode<A,L>,W,ValueEdge<A,L,W>> weightedEdgeToFrom()

weightedEdgeTo

public static <A,L,W> Fn2<ValueNode<A,L>,W,ValueEdge<A,L,W>> weightedEdgeTo(ValueNode<A,L> to)

Curried function creating an edge to a given node

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

W - The type of the edge's weight metadata

Parameters:

to - ValueNode the edge ends at

Returns:

A function taking a from node and a weight to produce an edge

weightedEdgeFrom

public static <A,L,W> Fn2<ValueNode<A,L>,W,ValueEdge<A,L,W>> weightedEdgeFrom(ValueNode<A,L> from)

Curried function creating an edge from a given node

Type Parameters:

A - The type of the nodes' IDs

L - The type of the nodes' label metadata

W - The type of the edge's weight metadata

Parameters:

from - ValueNode the edge comes from

Returns:

A function taking a to node and a weight to produce an edge

getWeight

public W getWeight()

Specified by:

getWeight in interface WeightedEdge<A,ValueNode<A,L>,W,ValueEdge<A,L,W>>

Returns:

The edge's weight metadata

getNodeFrom

public ValueNode<A,L> getNodeFrom()

Specified by:

getNodeFrom in interface Edge<A,ValueNode<A,L>,ValueEdge<A,L,W>>

Returns:

The node the edge leaves from

getNodeTo

public ValueNode<A,L> getNodeTo()

Specified by:

getNodeTo in interface Edge<A,ValueNode<A,L>,ValueEdge<A,L,W>>

Returns:

The node the edge goes to

swap

public ValueEdge<A,L,W> swap()

Specified by:

swap in interface Edge<A,ValueNode<A,L>,ValueEdge<A,L,W>>

Returns:

An edge going in the reverse direction

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object