tk.pratanumandal.expr4j.token

Class Operator

java.lang.Object

tk.pratanumandal.expr4j.token.Token

tk.pratanumandal.expr4j.token.Operator

All Implemented Interfaces:

Comparable<Operator>

public class Operator
extends Token
implements Comparable<Operator>

The Operator class represents the operators, functions, variables, and constants in the expression.

It provides implementation for evaluation of the operators, functions, variables, and constants.
Functions, variables, and constants are treated as operators as well with specialized evaluation techniques in order to maintain precedence and associativity.

Since:

0.0.1

Author:

Pratanu Mandal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Operator.Properties The Properties class represents the properties of an operator. It contains information about the number of parameters supported, the precedence, and the associativity. It also helps determine if an operator is a function or not and provides the function implementation.

Field Summary

Fields inherited from class tk.pratanumandal.expr4j.token.Token

value

Constructor Summary

Constructors

Constructor and Description
Operator(String value) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Operator other) Method to compare this operator to another operator on the basis of precedence.
Operand	evaluate(Operand... operands) Method to evaluate this operator, function, variable, or constant. It takes a variable number of operands as parameter depending on the number of operands required for this operator.
Operator.Properties.Associativity	getAssociativity() Get associativity information of this operator.
int	getOperandCount() Get count of operands supported by this operator.
boolean	isFunction() Determine if this operator is a function or not.
boolean	isVariableOrConstant() Determine if this operator is a variable or constant, or not.

Methods inherited from class tk.pratanumandal.expr4j.token.Token

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Operator

public Operator(String value)

Parameterized constructor.

Parameters:

value - The operator, function, variable, or constant as a string

Method Detail

getOperandCount

public int getOperandCount()

Get count of operands supported by this operator.

Returns:

number of operands supported by this operator

getAssociativity

public Operator.Properties.Associativity getAssociativity()

Get associativity information of this operator.

Returns:

Associativity of this operator

isFunction

public boolean isFunction()

Determine if this operator is a function or not.

Returns:

true if this operator is a function, otherwise false

isVariableOrConstant

public boolean isVariableOrConstant()

Determine if this operator is a variable or constant, or not.

Returns:

true if this operator is a variable or constant, otherwise false

evaluate

public Operand evaluate(Operand... operands)

Method to evaluate this operator, function, variable, or constant.
It takes a variable number of operands as parameter depending on the number of operands required for this operator.

Parameters:

operands - Variable number of operands required by this operator

Returns:

The evaluated result as another operand

compareTo

public int compareTo(Operator other)

Method to compare this operator to another operator on the basis of precedence.

Specified by:

compareTo in interface Comparable<Operator>