Class MathExpression.VariableRegistry

java.lang.Object

com.github.gbenroscience.parser.MathExpression.VariableRegistry

All Implemented Interfaces:

Savable, Serializable

Enclosing class:

MathExpression

public static final class MathExpression.VariableRegistry
extends Object
implements Savable

Manages the mapping of variable names to frame slots. Use one instance per MathExpression compilation.

Author:

GBENRO

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
VariableRegistry()

Method Summary

Modifier and Type	Method	Description
void	add(Variable v)	Introduces a Variable
void	add(Variable... vars)	Introduces an array or variable-args list of Variable
MathExpression.VariableRegistry	clone()
void	dumpVars()
int	getSlot(String name)	Returns the slot index for a variable name.
boolean	hasVariable(String name)
Variable	lookUp(String vName)	Search for a Variable only in the local MathExpression.VariableRegistry of the MathExpression.
Variable	lookUp(String vName, boolean localOnly)	Gives no choice but to search for a Variable only in the local MathExpression.VariableRegistry of the MathExpression
void	reset()
Variable	saveIfNotExists(Variable v)
Variable	saveOrUpdate(Variable v)	Do not use except if necessary
int	size()	Returns the total number of slots required for the execution frame.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.gbenroscience.interfaces.Savable

serialize

Constructor Details

VariableRegistry

public VariableRegistry()

Method Details

getSlot

public int getSlot(String name)

Returns the slot index for a variable name. If the name is new, it assigns a new slot.

Parameters:

name - The name of the Variable

hasVariable

public boolean hasVariable(String name)

lookUp

public Variable lookUp(String vName)

Search for a Variable only in the local MathExpression.VariableRegistry of the MathExpression.

Parameters:

vName - The name of the MathExpression

Returns:

the Variable if found or null

lookUp

public Variable lookUp(String vName,
 boolean localOnly)

Gives no choice but to search for a Variable only in the local MathExpression.VariableRegistry of the MathExpression

Parameters:

vName - The name of the MathExpression

localOnly - If true, will only check the MathExpression's MathExpression.VariableRegistry

Returns:

saveIfNotExists

public Variable saveIfNotExists(Variable v)

saveOrUpdate

public Variable saveOrUpdate(Variable v)

Do not use except if necessary

Parameters:

v -

Returns:

add

public void add(Variable v)

Introduces a Variable

Parameters:

v - the name of the Variable object to be added to the Variable Registry

add

public void add(Variable... vars)

Introduces an array or variable-args list of Variable

Parameters:

vars - the variable args list of the Variable objects to be added to the Variable Registry

size

public int size()

Returns the total number of slots required for the execution frame.

reset

public void reset()

dumpVars

public void dumpVars()

clone

public MathExpression.VariableRegistry clone()

Overrides:

clone in class Object