ca.uqac.lif.dag

Class NestedNode

java.lang.Object

ca.uqac.lif.dag.Node

ca.uqac.lif.dag.NestedNode

All Implemented Interfaces:

Connectable, Duplicable

Direct Known Subclasses:

Circuit

public class NestedNode
extends Node

A node that itself encloses a directed acyclic graph of other nodes. The input/output pins of some of these nodes may be associated to the input/output pins of the global container node.

Author:

Sylvain Hallé

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NestedNode.CopyCrawler A crawler that creates copies of all visited nodes and connects them in the same way as the originals.
static class	NestedNode.NestedNodeCrawler A crawler visiting all inner nodes of the nested node.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,Pin<? extends Node>>	m_inputAssociations A map storing associations between the node's input pins and an input pin of some internal node.
protected java.util.List<Node>	m_internalNodes The internal nodes contained within this node.
protected java.util.Map<java.lang.Integer,Pin<? extends Node>>	m_outputAssociations A map storing associations between the node's output pins and an output pin of some internal node.

Fields inherited from class ca.uqac.lif.dag.Node

m_inputs, m_outputs

Constructor Summary

Constructors

Constructor and Description
NestedNode(int in_arity, int out_arity) Creates a new empty nested node.

Method Summary

Modifier and Type	Method and Description
void	addNodes(java.util.Collection<? extends Node> nodes) Adds nodes to the internal nodes of this nested node.
void	addNodes(Node... nodes) Adds nodes to the internal nodes of this nested node.
void	associateInput(int i, Pin<? extends Node> p) Associates an input pin of the nested node to an input pin of one of its internal nodes.
void	associateOutput(int i, Pin<? extends Node> p) Associates an input pin of the nested node to an output pin of one of its internal nodes.
protected void	copyInto(NestedNode nn, boolean with_state)
static NestedNode	createFromTree(Node root) Creates a new nested node from a tree of connected nodes.
NestedNode	duplicate(boolean with_state) Creates a possibly stateful copy of an object.
Pin<? extends Node>	getAssociatedInput(int i) Gets the input pin of the internal node associated to a given input pin of the nested node.
Pin<? extends Node>	getAssociatedOutput(int i) Gets the output pin of the internal node associated to a given output pin of the nested node.
protected NodeConnector	getConnector() Gets an instance of node connector.
int	getNestedInput(Node node, int index) Gets the nested node input to which the n-th input of an inner node is associated with.

Methods inherited from class ca.uqac.lif.dag.Node

addToInput, addToOutput, copyInto, duplicate, getInputArity, getInputLinks, getInputPin, getOutputArity, getOutputLinks, getOutputPin, removeFromInput, removeFromOutput, setToInput, setToOutput

Methods inherited from class java.lang.Object

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

Field Detail

m_internalNodes

protected java.util.List<Node> m_internalNodes

The internal nodes contained within this node.

m_inputAssociations

protected java.util.Map<java.lang.Integer,Pin<? extends Node>> m_inputAssociations

A map storing associations between the node's input pins and an input pin of some internal node.

m_outputAssociations

protected java.util.Map<java.lang.Integer,Pin<? extends Node>> m_outputAssociations

A map storing associations between the node's output pins and an output pin of some internal node.

Constructor Detail

NestedNode

public NestedNode(int in_arity,
                  int out_arity)

Creates a new empty nested node.

Parameters:

in_arity - The node's input arity

out_arity - The node's output arity

Method Detail

createFromTree

public static NestedNode createFromTree(Node root)

Creates a new nested node from a tree of connected nodes.

Parameters:

root - The root of the tree

Returns:

A new nested node

associateInput

public void associateInput(int i,
                           Pin<? extends Node> p)

Associates an input pin of the nested node to an input pin of one of its internal nodes.

Parameters:

i - The index of the node's input pin

p - The input pin of the internal node

getAssociatedInput

public Pin<? extends Node> getAssociatedInput(int i)

Gets the input pin of the internal node associated to a given input pin of the nested node.

Parameters:

i - The index of the input pin of the nested node

Returns:

The input pin of an internal node

associateOutput

public void associateOutput(int i,
                            Pin<? extends Node> p)

Associates an input pin of the nested node to an output pin of one of its internal nodes.

Parameters:

i - The index of the node's output pin

p - The output pin of the internal node

getAssociatedOutput

public Pin<? extends Node> getAssociatedOutput(int i)

Gets the output pin of the internal node associated to a given output pin of the nested node.

Parameters:

i - The index of the output pin of the nested node

Returns:

The output pin of an internal node

addNodes

public void addNodes(java.util.Collection<? extends Node> nodes)

Adds nodes to the internal nodes of this nested node.

Parameters:

nodes - The nodes to add

addNodes

public void addNodes(Node... nodes)

Adds nodes to the internal nodes of this nested node.

Parameters:

nodes - The nodes to add

getNestedInput

public int getNestedInput(Node node,
                          int index)

Gets the nested node input to which the n-th input of an inner node is associated with.

Parameters:

node - The node

index - The value of n in the previous description

Returns:

The nested node input number, or -1 of node is not associated to an input of the nested node

duplicate

public NestedNode duplicate(boolean with_state)

Description copied from interface: Duplicable

Creates a possibly stateful copy of an object.

Specified by:

duplicate in interface Duplicable

Overrides:

duplicate in class Node

Parameters:

with_state - Set to true for a stateful copy, false otherwise

Returns:

The object's copy

copyInto

protected void copyInto(NestedNode nn,
                        boolean with_state)

getConnector

protected NodeConnector getConnector()

Gets an instance of node connector. This connector is used to connect nodes when creating a duplicate of the nested node. Descendants of this class can override this method if they require their nodes to be connected by a different connector than the package's basic NodeConnector.

Returns:

A node connector