org.matheclipse.core.eval.util

Class LevelSpec

java.lang.Object

org.matheclipse.core.eval.util.LevelSpec

Direct Known Subclasses:

LevelSpecification

public class LevelSpec
extends java.lang.Object

A level specification definition for levels in nested lists. Example: the nested list [x,[y]] has depth 3

Field Summary

Fields

Modifier and Type	Field and Description
protected int	fCurrentDepth
protected int	fCurrentLevel
protected int	fFromDepth
protected int	fFromLevel
protected boolean	fIncludeHeads
protected int	fToDepth
protected int	fToLevel

Constructor Summary

Constructors

Constructor and Description
LevelSpec()
LevelSpec(int level) Define a level specification for all elements on level level.
LevelSpec(int level, boolean includeHeads)
LevelSpec(int fromLevel, int toLevel)
LevelSpec(int fromLevel, int toLevel, boolean includeHeads)
LevelSpec(int fromLevel, int toLevel, int fromDepth, int toDepth, boolean includeHeads) Example value set for including all levels: fromLevel = 0; toLevel = Integer.MAX_VALUE; fromDepth = Integer.MIN_VALUE; toDepth = -1;

Method Summary

Modifier and Type	Method and Description
void	decCurrentDepth()
void	decCurrentLevel() Decrements the current level
int	getCurrentDepth()
int	getCurrentLevel() Get the current level
int	getFromDepth()
int	getFromLevel()
int	getToDepth()
int	getToLevel()
void	incCurrentLevel() Increments the current level
boolean	isIncludeHeads()
boolean	isInRange()
boolean	isInScope()
void	resetCurrentLevel()
void	setCurrentDepth(int currentDepth)
void	setCurrentLevel(int currentLevel)
void	setFromLevelAsCurrent()
void	setToLevelAsCurrent()

Methods inherited from class java.lang.Object

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

Field Detail

fFromLevel

protected int fFromLevel

fToLevel

protected int fToLevel

fFromDepth

protected int fFromDepth

fToDepth

protected int fToDepth

fIncludeHeads

protected boolean fIncludeHeads

fCurrentLevel

protected int fCurrentLevel

fCurrentDepth

protected int fCurrentDepth

Constructor Detail

LevelSpec

public LevelSpec()

LevelSpec

public LevelSpec(int level)

Define a level specification for all elements on level level.

Parameters:

level -

LevelSpec

public LevelSpec(int level,
                 boolean includeHeads)

LevelSpec

public LevelSpec(int fromLevel,
                 int toLevel)

LevelSpec

public LevelSpec(int fromLevel,
                 int toLevel,
                 boolean includeHeads)

LevelSpec

public LevelSpec(int fromLevel,
                 int toLevel,
                 int fromDepth,
                 int toDepth,
                 boolean includeHeads)

Example value set for including all levels:
fromLevel = 0;
toLevel = Integer.MAX_VALUE;
fromDepth = Integer.MIN_VALUE;
toDepth = -1;

Parameters:

fromLevel -

toLevel -

fromDepth -

toDepth -

includeHeads -

Method Detail

getCurrentLevel

public final int getCurrentLevel()

Get the current level

resetCurrentLevel

public final void resetCurrentLevel()

setFromLevelAsCurrent

public final void setFromLevelAsCurrent()

setToLevelAsCurrent

public final void setToLevelAsCurrent()

decCurrentDepth

public final void decCurrentDepth()

incCurrentLevel

public final void incCurrentLevel()

Increments the current level

decCurrentLevel

public final void decCurrentLevel()

Decrements the current level

isInRange

public boolean isInRange()

isInScope

public boolean isInScope()

getCurrentDepth

public final int getCurrentDepth()

setCurrentDepth

public final void setCurrentDepth(int currentDepth)

setCurrentLevel

public final void setCurrentLevel(int currentLevel)

getFromLevel

public int getFromLevel()

Returns:

the from level

getToLevel

public int getToLevel()

Returns:

the to level

getFromDepth

public int getFromDepth()

Returns:

the from depth

getToDepth

public int getToDepth()

Returns:

the to depth

isIncludeHeads

public boolean isIncludeHeads()

Returns:

if the level includes the heads of an expression