com.bluegosling.graph

Class Node<T>

java.lang.Object

com.bluegosling.graph.Node<T>

Type Parameters:

T - the type of value produced by this node's operation

public abstract class Node<T>
extends Object

A node in a computation graph. Each node represents an operation that produces a value. The operation may have inputs, which are edges that connect it to other nodes in the graph. The output may be used as the input to another operation, which is also an edge that connects this node to another. Up to ten inputs are allowed.

See Also:

builder(), Graph

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Node.Input<T> An input to a node.
static class	Node.NodeBuilder0 A factory for nodes with zero or more inputs.
static class	Node.NodeBuilder1<A> A factory for nodes with one or more inputs.
static class	Node.NodeBuilder10<A,B,C,D,E,F,G,H,I,J> A factory for nodes with ten inputs.
static class	Node.NodeBuilder2<A,B> A factory for nodes with two or more inputs.
static class	Node.NodeBuilder3<A,B,C> A factory for nodes with three or more inputs.
static class	Node.NodeBuilder4<A,B,C,D> A factory for nodes with four or more inputs.
static class	Node.NodeBuilder5<A,B,C,D,E> A factory for nodes with five or more inputs.
static class	Node.NodeBuilder6<A,B,C,D,E,F> A factory for nodes with six or more inputs.
static class	Node.NodeBuilder7<A,B,C,D,E,F,G> A factory for nodes with seven or more inputs.
static class	Node.NodeBuilder8<A,B,C,D,E,F,G,H> A factory for nodes with eight or more inputs.
static class	Node.NodeBuilder9<A,B,C,D,E,F,G,H,I> A factory for nodes with nine or more inputs.

Method Summary

Modifier and Type	Method and Description
<U> Node<U>	andThen(Function<T,U> fn) Returns a new node that is the result of applying the given function to the values produced by this node.
static Node.NodeBuilder0	builder() Returns a new node builder.
Set<Node<?>>	dependencies() The distinct set of other nodes that this node depends on.
Set<Key<?>>	inputKeys() The distinct set of inputs that are defined as Keys.
List<Node.Input<?>>	inputs() Returns the list of input edges to this node.
Graph<T>	toGraph() Returns a graph consisting of this node and its transitive dependencies.

Methods inherited from class java.lang.Object

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

Method Detail

inputs

public List<Node.Input<?>> inputs()

Returns the list of input edges to this node. An input can be another Node or a Key

Returns:

the list of input edges

inputKeys

public Set<Key<?>> inputKeys()

The distinct set of inputs that are defined as Keys. These inputs are bound to a value when the computation graph is executed.

Returns:

the set of Key inputs

dependencies

public Set<Node<?>> dependencies()

The distinct set of other nodes that this node depends on. These are inputs that are linked to other nodes in the graph.

Returns:

the set of Node inputs

andThen

public <U> Node<U> andThen(Function<T,U> fn)

Returns a new node that is the result of applying the given function to the values produced by this node. This implicitly adds a new node to the graph whose sole input is this node.

Parameters:

fn - the function that produces values for the new node, given products from this node

Returns:

a new node that is the result of applying the given function to the values produced by this node

toGraph

public Graph<T> toGraph()

Returns a graph consisting of this node and its transitive dependencies. Executing the graph yields values that are produced by this node.

Returns:

a graph that yields values produced by this node

builder

public static Node.NodeBuilder0 builder()

Returns a new node builder.

Returns:

a new node builder