ca.uqac.lif.dag

Class Node

java.lang.Object

ca.uqac.lif.dag.Node

All Implemented Interfaces:

Connectable, Duplicable

Direct Known Subclasses:

AtomicFunction, LabelledNode, NestedNode

public class Node
extends java.lang.Object
implements Connectable, Duplicable

Abstract entity having input and output pins that can be linked to pins of of other nodes.

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,java.util.List<Pin<? extends Node>>>	m_inputs A map associating input pin indices with a list of output pins of other nodes.
protected java.util.Map<java.lang.Integer,java.util.List<Pin<? extends Node>>>	m_outputs A map associating output pin indices with a list of input pins of other nodes.

Constructor Summary

Constructors

Constructor and Description
Node(int in_arity, int out_arity) Creates a new node.

Method Summary

Modifier and Type	Method and Description
void	addToInput(int index, Pin<? extends Node> pin) Adds a node's output pin to the set of connections of this node's input pin.
void	addToOutput(int index, Pin<? extends Node> pin) Adds a node's input pin to the set of connections of this node's output pin.
protected void	copyInto(Node n, boolean with_state) Copies the contents of the current node into another node instance.
Node	duplicate() Creates a copy of an object.
Node	duplicate(boolean with_state) Creates a possibly stateful copy of an object.
int	getInputArity() Gets the input arity of the node.
java.util.Collection<Pin<? extends Node>>	getInputLinks(int index) Gets the output pins of other nodes that are connected to a given input pin of this node.
Pin<? extends Node>	getInputPin(int index) Gets the node's input pin for a given index.
int	getOutputArity() Gets the output arity of the node.
java.util.List<Pin<? extends Node>>	getOutputLinks(int index) Gets the input pins of other nodes that are connected to a given output pin of this node.
Pin<? extends Node>	getOutputPin(int index) Gets the node's input pin for a given index.
void	removeFromInput(int index, Pin<? extends Node> pin) Removes a node's output pin to the set of connections of this node's input pin.
void	removeFromOutput(int index, Pin<? extends Node> pin) Removes a node's input pin to the set of connections of this node's output pin.
void	setToInput(int index, Pin<? extends Node> pin) Sets a node's output pin as the connection of this node's input pin.
void	setToOutput(int index, Pin<? extends Node> pin) Sets a node's input pin as the connection of this node's output pin.

Methods inherited from class java.lang.Object

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

Field Detail

m_inputs

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

A map associating input pin indices with a list of output pins of other nodes.

m_outputs

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

A map associating output pin indices with a list of input pins of other nodes.

Constructor Detail

Node

public Node(int in_arity,
            int out_arity)

Creates a new node.

Parameters:

in_arity - The number of input pins on this node

out_arity - The number of output pins on this node

Method Detail

getInputArity

public int getInputArity()

Description copied from interface: Connectable

Gets the input arity of the node. The input arity is the number of input pins of this node.

Specified by:

getInputArity in interface Connectable

Returns:

The input arity

getOutputArity

public int getOutputArity()

Description copied from interface: Connectable

Gets the output arity of the node. The input arity is the number of output pins of this node.

Specified by:

getOutputArity in interface Connectable

Returns:

The input arity

getInputLinks

public java.util.Collection<Pin<? extends Node>> getInputLinks(int index)

Description copied from interface: Connectable

Gets the output pins of other nodes that are connected to a given input pin of this node.

Specified by:

getInputLinks in interface Connectable

Parameters:

index - The index of the current node's input pin

Returns:

The collection of output pins of other nodes

getOutputLinks

public java.util.List<Pin<? extends Node>> getOutputLinks(int index)

Description copied from interface: Connectable

Gets the input pins of other nodes that are connected to a given output pin of this node.

Specified by:

getOutputLinks in interface Connectable

Parameters:

index - The index of the current node's output pin

Returns:

The collection of input pins of other nodes

addToInput

public void addToInput(int index,
                       Pin<? extends Node> pin)

Description copied from interface: Connectable

Adds a node's output pin to the set of connections of this node's input pin. If other pins are already associated to this input pin, they are kept.

Specified by:

addToInput in interface Connectable

Parameters:

index - The index of the current node's input pin

pin - A node's output pin to add to the connections

setToInput

public void setToInput(int index,
                       Pin<? extends Node> pin)

Description copied from interface: Connectable

Sets a node's output pin as the connection of this node's input pin. If other pins are already associated to this input pin, they are deleted.

Specified by:

setToInput in interface Connectable

Parameters:

index - The index of the current node's input pin

pin - A node's output pin to add to the connections

removeFromInput

public void removeFromInput(int index,
                            Pin<? extends Node> pin)

Description copied from interface: Connectable

Removes a node's output pin to the set of connections of this node's input pin. If other pins are already associated to this input pin, they are kept.

Specified by:

removeFromInput in interface Connectable

Parameters:

index - The index of the current node's input pin

pin - A node's output pin to remove from the connections

addToOutput

public void addToOutput(int index,
                        Pin<? extends Node> pin)

Description copied from interface: Connectable

Adds a node's input pin to the set of connections of this node's output pin. If other pins are already associated to this output pin, they are kept.

Specified by:

addToOutput in interface Connectable

Parameters:

index - The index of the current node's output pin

pin - A node's input pin to add to the connections

setToOutput

public void setToOutput(int index,
                        Pin<? extends Node> pin)

Description copied from interface: Connectable

Sets a node's input pin as the connection of this node's output pin. If other pins are already associated to this output pin, they are deleted.

Specified by:

setToOutput in interface Connectable

Parameters:

index - The index of the current node's output pin

pin - A node's input pin to add to the connections

removeFromOutput

public void removeFromOutput(int index,
                             Pin<? extends Node> pin)

Description copied from interface: Connectable

Removes a node's input pin to the set of connections of this node's output pin. If other pins are already associated to this output pin, they are kept.

Specified by:

removeFromOutput in interface Connectable

Parameters:

index - The index of the current node's output pin

pin - A node's input pin to remove from the connections

getInputPin

public Pin<? extends Node> getInputPin(int index)
                                throws java.lang.IndexOutOfBoundsException

Description copied from interface: Connectable

Gets the node's input pin for a given index.

Specified by:

getInputPin in interface Connectable

Parameters:

index - The index

Returns:

The pin

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's input arity

getOutputPin

public Pin<? extends Node> getOutputPin(int index)
                                 throws java.lang.IndexOutOfBoundsException

Description copied from interface: Connectable

Gets the node's input pin for a given index.

Specified by:

getOutputPin in interface Connectable

Parameters:

index - The index

Returns:

The pin

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's output arity

duplicate

public Node duplicate()

Description copied from interface: Duplicable

Creates a copy of an object. The behavior of this method is equivalent to duplicate(false).

Specified by:

duplicate in interface Duplicable

Returns:

The object's copy

duplicate

public Node duplicate(boolean with_state)

Description copied from interface: Duplicable

Creates a possibly stateful copy of an object.

Specified by:

duplicate in interface Duplicable

Parameters:

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

Returns:

The object's copy

copyInto

protected void copyInto(Node n,
                        boolean with_state)

Copies the contents of the current node into another node instance.

Parameters:

n - The other node

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