Class NumberReturningStatsOperator

java.lang.Object

com.github.gbenroscience.parser.Operator

com.github.gbenroscience.parser.NumberReturningStatsOperator

All Implemented Interfaces:

Validatable

public class NumberReturningStatsOperator
extends Operator
implements Validatable

Deals with number returning statistical operators e.g sum,avg,mode e.t.c and log and antilog to any base operators

Author:

GBEMIRO

Field Summary

Fields inherited from class com.github.gbenroscience.parser.Operator

AND, ASSIGN, AT, CLOSE_CIRC_BRAC, CLOSE_SQUARE_BRAC, COLON, COMBINATION, COMMA, CONST, CUBE, CUBE_ROOT, DIVIDE, EN_DASH, EQUALS, EXIT, FACTORIAL, GREATER_OR_EQUALS, GREATER_THAN, INVERSE, LESS_OR_EQUALS, LESS_THAN, MINUS, MULTIPLY, name, OPEN_CIRC_BRAC, OPEN_SQUARE_BRAC, operators, OR, PERMUTATION, PLUS, POWER, REMAINDER, ROOT, SEMI_COLON, SPACE, SQUARE, STORE

Constructor Summary

Constructors

Constructor	Description
NumberReturningStatsOperator(String name, int index, ArrayList<String> scan)

Method Summary

Modifier and Type	Method	Description
int	getIndex()
void	setIndex(int index, ArrayList<String> scan)
boolean	validate(ArrayList<String> scan)

Methods inherited from class com.github.gbenroscience.parser.Operator

getName, getPrecedence, isAssignmentOperator, isAtOperator, isBinaryOperator, isBracket, isClosingBrace, isClosingBracket, isColon, isComma, isConstantStoreCommand, isCube, isCubeRoot, isEqualsOperator, isExitCommand, isFactorial, isGreaterOrEqualsOperator, isGreaterThanOperator, isInverse, isLessThanOperator, isLessThanOrEqualsOperator, isLogicOperator, isMulOrDiv, isMulOrDivOrRemOrPermOrCombOrPow, isOpeningBrace, isOpeningBracket, isOperatorString, isPermOrComb, isPlusOrMinus, isPower, isRemainder, isSemiColon, isSquare, isSquareRoot, isStoreCommand, isUnaryPostOperator, isUnaryPreOperator, setName, validateAll

Methods inherited from class java.lang.Object

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

Constructor Details

NumberReturningStatsOperator

public NumberReturningStatsOperator(String name,
 int index,
 ArrayList<String> scan)

Parameters:

name - The name of this Operator with which it is represented in a math function.

index - the location of this Operator object in its parent Function object's scanned ArrayList object.

scan - The scanner output

Method Details

setIndex

public void setIndex(int index,
 ArrayList<String> scan)

Parameters:

index - sets the index of this operator in the scanned Function that it belongs to.

scan - The scanner output

getIndex

public int getIndex()

Returns:

the index of this operator in the scanned Function that it belongs to.

validate

public boolean validate(ArrayList<String> scan)

Specified by:

validate in interface Validatable

Parameters:

scan - the ArrayList object that this NumberReturningStatsOperator object exists in. validates the grammatical usage of this operator (by leaving the correctFunction attribute of the Function object un-modified) if the usage of this operator in its immediate environment i.e to its left and right is correct.

Returns:

true if valid