net.automatalib.graphs.ads

Interface RecursiveADSNode<S,I,O,N extends RecursiveADSNode<S,I,O,N>>

Type Parameters:

S - (hypothesis) state type

I - input alphabet type

O - output alphabet type

N - the concrete node type

All Superinterfaces:

Graph<N,N>, IndefiniteGraph<N,N>, IndefiniteSimpleGraph<N>, Iterable<N>, SimpleGraph<N>

All Known Subinterfaces:

ADSNode<S,I,O>

public interface RecursiveADSNode<S,I,O,N extends RecursiveADSNode<S,I,O,N>>
extends Graph<N,N>

An interface representing a node in an adaptive distinguishing sequence (which essentially forms a decision tree).

For convenience, this interface extends the Graph interface so that an ADS may be passed easily to e.g. GraphDOT methods.

This is a utility interface with a recursive generic type parameter to allow for better inheritance with this recursive data structure. Algorithms may use more simplified sub-interfaces such as ADSNode.

Author:

frohme

Nested Class Summary

Nested classes/interfaces inherited from interface net.automatalib.graphs.SimpleGraph

SimpleGraph.NormalGraphView<N,G extends SimpleGraph<N>>

Method Summary

Modifier and Type	Method and Description
Map<O,N>	getChildren() Returns a mapping to the child nodes of this ADS node.
S	getHypothesisState() Returns the hypothesis state associated with this ADS node.
default Collection<N>	getNodesForRoot(N root) A utility method to collect all nodes of a subtree specified by the given root node.
default Collection<N>	getOutgoingEdges(N node) Retrieves the outgoing edges of a given node.
N	getParent() Returns the parent node of this node.
I	getSymbol() Returns the input symbol associated with this ADS node.
default N	getTarget(N edge) Retrieves, for a given edge, its target node.
default VisualizationHelper<N,N>	getVisualizationHelper()
boolean	isLeaf() A utility method indicating whether this node represents a leaf of an ADS (and therefore referencing a hypothesis state) or an inner node (and therefore referencing an input symbol).
void	setHypothesisState(S state) See getHypothesisState().
void	setParent(N parent)
void	setSymbol(I symbol) See getSymbol().

Methods inherited from interface net.automatalib.graphs.Graph

asNormalGraph

Methods inherited from interface net.automatalib.graphs.IndefiniteGraph

adjacentTargetsIterator, adjacentTargetsStream, getAdjacentTargets, getEdgesBetween, outgoingEdges, outgoingEdgesIterator, outgoingEdgesStream

Methods inherited from interface net.automatalib.graphs.SimpleGraph

getNodes, iterator, nodeIDs, nodesStream, size

Methods inherited from interface net.automatalib.graphs.IndefiniteSimpleGraph

adjacentTargets, createDynamicNodeMapping, createStaticNodeMapping, isConnected

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getSymbol

I getSymbol()

Returns the input symbol associated with this ADS node.

Returns:

null if this is a leaf node (see isLeaf()), the associated input symbol otherwise.

setSymbol

void setSymbol(I symbol)
        throws UnsupportedOperationException

See getSymbol().

Parameters:

symbol - the input symbol to be associated with this ADS node.

Throws:

UnsupportedOperationException - if trying to set an input symbol on a leaf node (see isLeaf()).

getParent

N getParent()

Returns the parent node of this node.

Returns:

The parent node of this ADS node. May be null, if this is the root node of an ADS.

setParent

void setParent(N parent)

getNodesForRoot

default Collection<N> getNodesForRoot(N root)

A utility method to collect all nodes of a subtree specified by the given root node. May be used for the SimpleGraph.getNodes() implementation where a concrete type for N is needed.

Parameters:

root - the node for which all subtree nodes should be collected

Returns:

all nodes in the specified subtree, including the root node itself

getChildren

Map<O,N> getChildren()

Returns a mapping to the child nodes of this ADS node.

Returns:

A mapping from hypothesis outputs to child ADS nodes. May be empty/unmodifiable (for leaf nodes), but never null.

getOutgoingEdges

default Collection<N> getOutgoingEdges(N node)

Description copied from interface: IndefiniteGraph

Retrieves the outgoing edges of a given node.

Specified by:

getOutgoingEdges in interface IndefiniteGraph<N extends RecursiveADSNode<S,I,O,N>,N extends RecursiveADSNode<S,I,O,N>>

Parameters:

node - the node.

Returns:

a Collection of all outgoing edges, or null if the node has no outgoing edges.

getTarget

default N getTarget(N edge)

Description copied from interface: IndefiniteGraph

Retrieves, for a given edge, its target node.

Specified by:

getTarget in interface IndefiniteGraph<N extends RecursiveADSNode<S,I,O,N>,N extends RecursiveADSNode<S,I,O,N>>

Parameters:

edge - the edge.

Returns:

the target node of the given edge.

getVisualizationHelper

default VisualizationHelper<N,N> getVisualizationHelper()

Specified by:

getVisualizationHelper in interface Graph<N extends RecursiveADSNode<S,I,O,N>,N extends RecursiveADSNode<S,I,O,N>>

Specified by:

getVisualizationHelper in interface SimpleGraph<N extends RecursiveADSNode<S,I,O,N>>

isLeaf

boolean isLeaf()

A utility method indicating whether this node represents a leaf of an ADS (and therefore referencing a hypothesis state) or an inner node (and therefore referencing an input symbol).

Returns:

true if this is a leaf of an ADS, false otherwise.

getHypothesisState

S getHypothesisState()

Returns the hypothesis state associated with this ADS node.

Returns:

null if this is an inner node (see isLeaf()), the associated hypothesis state otherwise.

setHypothesisState

void setHypothesisState(S state)
                 throws UnsupportedOperationException

See getHypothesisState().

Parameters:

state - the hypothesis state to be associated with this ADS node.

Throws:

UnsupportedOperationException - if trying to set a hypothesis state on an inner node (see isLeaf()).