cc.redberry.core.transformations.substitutions

Class SubstitutionIterator

java.lang.Object

cc.redberry.core.transformations.substitutions.SubstitutionIterator

All Implemented Interfaces:

TreeIterator

public final class SubstitutionIterator
extends java.lang.Object
implements TreeIterator

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
SubstitutionIterator(Tensor tensor)
SubstitutionIterator(Tensor tensor, TraverseGuide traverseGuide)

Method Summary

Modifier and Type	Method and Description
int	depth() Returns the current depth in the tree.
int[]	getForbidden()
boolean	isCurrentModified()
Tensor	next() Returns the next tensor in tree or null if iteration is finished
Tensor	result() Returns the result after iteration finished (or stopped).
void	safeSet(Tensor tensor)
void	set(Tensor tensor) Set current tensor in tree.
void	set(Tensor tensor, boolean supposeIndicesAreAdded)
void	unsafeSet(Tensor tensor)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstitutionIterator

public SubstitutionIterator(Tensor tensor)

SubstitutionIterator

public SubstitutionIterator(Tensor tensor,
                            TraverseGuide traverseGuide)

Method Detail

next

public Tensor next()

Description copied from interface: TreeIterator

Returns the next tensor in tree or null if iteration is finished

Specified by:

next in interface TreeIterator

Returns:

the next tensor in tree or null if iteration is finished

unsafeSet

public void unsafeSet(Tensor tensor)

set

public void set(Tensor tensor)

Description copied from interface: TreeIterator

Set current tensor in tree.

Specified by:

set in interface TreeIterator

Parameters:

tensor - tensor

set

public void set(Tensor tensor,
                boolean supposeIndicesAreAdded)

safeSet

public void safeSet(Tensor tensor)

isCurrentModified

public boolean isCurrentModified()

result

public Tensor result()

Description copied from interface: TreeIterator

Returns the result after iteration finished (or stopped). After this step the iterator becomes broken.

Specified by:

result in interface TreeIterator

Returns:

the result after iteration finished (or stopped)

depth

public int depth()

Description copied from interface: TreeIterator

Returns the current depth in the tree.

Specified by:

depth in interface TreeIterator

Returns:

current depth in the tree

getForbidden

public int[] getForbidden()