org.matheclipse.core.eval.util

Class LevelSpecification

java.lang.Object

org.matheclipse.core.eval.util.LevelSpec

org.matheclipse.core.eval.util.LevelSpecification

public class LevelSpecification
extends LevelSpec

Level specification for expression trees

Field Summary

Fields inherited from class org.matheclipse.core.eval.util.LevelSpec

fCurrentDepth, fCurrentLevel, fFromDepth, fFromLevel, fIncludeHeads, fToDepth, fToLevel

Constructor Summary

Constructors

Constructor and Description
LevelSpecification() Create a LevelSpecification with level from 0 to Integer.MAX_VALUE
LevelSpecification(IExpr expr, boolean includeHeads) Create a LevelSpecification from an IInteger or IAST list-object.
LevelSpecification(int level) Create a LevelSpecification with only the given level
LevelSpecification(int levelFrom, int levelTo) Create a LevelSpecification with the given level range

Method Summary

Modifier and Type	Method and Description
int	compareDepth(int i)
int	compareLevel()
int	compareLevel(int i)
int	getFrom() Get the low level-limit
int	getTo() Get the high level-limit.
boolean	includesDepth(int i)
boolean	includesLevel(int i)
void	setFrom(int i)
void	setTo(int i)

Methods inherited from class org.matheclipse.core.eval.util.LevelSpec

decCurrentDepth, decCurrentLevel, getCurrentDepth, getCurrentLevel, getFromDepth, getFromLevel, getToDepth, getToLevel, incCurrentLevel, isIncludeHeads, isInRange, isInScope, resetCurrentLevel, setCurrentDepth, setCurrentLevel, setFromLevelAsCurrent, setToLevelAsCurrent

Methods inherited from class java.lang.Object

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

Constructor Detail

LevelSpecification

public LevelSpecification()

Create a LevelSpecification with level from 0 to Integer.MAX_VALUE

LevelSpecification

public LevelSpecification(IExpr expr,
                          boolean includeHeads)

Create a LevelSpecification from an IInteger or IAST list-object.

If expr is a non-negative IInteger iValue set Level {1,iValue};
If expr is a negative IInteger iValue set Level {iValue, 0};
If expr is a List {i0Value, i1Value} set Level {i0Value, i1Value};

Parameters:

expr -

includeHeads - TODO

Throws:

MathException - if the expr is not a level specification

LevelSpecification

public LevelSpecification(int level)

Create a LevelSpecification with only the given level

LevelSpecification

public LevelSpecification(int levelFrom,
                          int levelTo)

Create a LevelSpecification with the given level range

Method Detail

getFrom

public int getFrom()

Get the low level-limit

Returns:

the from value of the level instance

getTo

public int getTo()

Get the high level-limit.

Returns:

the to value of the level instance

includesDepth

public final boolean includesDepth(int i)

includesLevel

public final boolean includesLevel(int i)

compareDepth

public final int compareDepth(int i)

compareLevel

public final int compareLevel()

compareLevel

public final int compareLevel(int i)

setFrom

public void setFrom(int i)

Parameters:

i -

setTo

public void setTo(int i)

Parameters:

i -