Package com.singularsys.extexamples.consoles

Class ExtensionsConsole

java.lang.Object

com.singularsys.jepexamples.consoles.Console

com.singularsys.extexamples.consoles.FieldConsole

com.singularsys.extexamples.consoles.ExtensionsConsole

public class ExtensionsConsole
extends FieldConsole

Console illustrating most of the features of jep extensions. Illustrates use of different fields, differentiation and symbolic operations, structured programming, matrix and statistical functions.

Since Jep 4.1 this now supports single quote strings and comments starting with a #. Dictionary creation and operations now supported through the MatrixDictComponents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExtensionsConsole.PrintfFunction	Class to add a print function.
class	ExtensionsConsole.PrintFunction	Class to add a print function.

Nested classes/interfaces inherited from class com.singularsys.extexamples.consoles.FieldConsole

FieldConsole.AllToComplexDecorator, FieldConsole.BigDecPFMC, FieldConsole.DoublePFMC, FieldConsole.RationalBigDecToDoubleDecorator, FieldConsole.RationalDoubleNumberFactory, FieldConsole.RationalPFMC, FieldConsole.RationalToBigDecDecorator, FieldConsole.Type

Nested classes/interfaces inherited from class com.singularsys.jepexamples.consoles.Console

Console.JepOutputStream, Console.JepPrintStream, Console.NodeRes, Console.SPEC_ACTION

Field Summary

Fields inherited from class com.singularsys.extexamples.consoles.FieldConsole

addStrings, baseField, decimalFormat, fields, funTab, mc, numf, opTab, scale, type, varFac, varTab

Fields inherited from class com.singularsys.jepexamples.consoles.Console

altered, doubleFormat, history, jep, showHistory

Constructor Summary

Constructors

Constructor	Description
ExtensionsConsole()

Method Summary

Modifier and Type	Method	Description
boolean	finaliseCommand(String command, Node node, Object res)	Perform any post-processing of a command after evaluation.
void	initialise()	sets up all the needed objects.
static void	main(String[] args)	Creates a new Console object and calls run()
void	printHelp()	Print help message.
void	printIntroText()	Prints introductory text.
Object	processEquation(Node node)	Performs the required operation on a node.
void	setEvaluator(Evaluator ev)	Sets the evaluator used.
void	setIndexShift(int i)	Set the index shift for arrays.
void	setMonitor(String[] args)	Sets up monitoring of the call tree.
void	showCalls()	Shows a summary of function, operator, variable and constant calls.
void	showTree()	Shows the call tree with counts and times.
Console.SPEC_ACTION	testSpecialCommands(String command)	Checks for special commands.
String	toString(Object o)	Return string representation of object.

Methods inherited from class com.singularsys.extexamples.consoles.FieldConsole

initBigDec, initBigInt, initComplex, initDouble, initExactInteger, initField, initFixed, initInteger, initMixed, initNone, initRational, initStandard, printFields, setField, setFormat, setFormat

Methods inherited from class com.singularsys.jepexamples.consoles.Console

clearVars, getCommand, getHistory, getJep, getPrompt, handleError, inputLoop, parseEvaluate, print, printFunctionEntry, printFuns, printHistory, println, printOps, printStdHelp, printVars, processCommand, run, setAlteredCommand, setFormat, split

Methods inherited from class java.lang.Object

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

Constructor Details

ExtensionsConsole

public ExtensionsConsole()

Method Details

initialise

public void initialise()

Description copied from class: Console

sets up all the needed objects.

Overrides:

initialise in class FieldConsole

printIntroText

public void printIntroText()

Description copied from class: Console

Prints introductory text.

Overrides:

printIntroText in class Console

printHelp

public void printHelp()

Description copied from class: Console

Print help message.

Overrides:

printHelp in class FieldConsole

testSpecialCommands

public Console.SPEC_ACTION testSpecialCommands(String command)

Description copied from class: Console

Checks for special commands. For example a subclass may have a verbose mode switched on of off using the command

 verbose on
 

This method can be used detected this input, perform required actions and skip normal processing by returning true.

In general subclasses should call the superclass methods to test for special commands that class implements

Overrides:

testSpecialCommands in class FieldConsole

Parameters:

command -

Returns:

One of

• SPEC_ACTION.CONTINUE - continue parsing and evaluation this equation,
• SPEC_ACTION.BREAK - stop processing this equation and add it to the history
• SPEC_ACTION.EMPTY - stop processing this equation does not add it to the history
• SPEC_ACTION.ALTERED - the input text has been altered, reprocess the new text
• SPEC_ACTION.EXIT stop the program

See Also:

• Console.split(String)

setIndexShift

public void setIndexShift(int i)

Description copied from class: Console

Set the index shift for arrays.

Overrides:

setIndexShift in class Console

Parameters:

i - the shift, either 0 or 1

finaliseCommand

public boolean finaliseCommand(String command,
 Node node,
 Object res)

Description copied from class: Console

Perform any post-processing of a command after evaluation.

Overrides:

finaliseCommand in class Console

Parameters:

command - the string expression

node - parsed expression

res - result of evaluation

Returns:

true, false indicates the program should exit.

processEquation

public Object processEquation(Node node)
                       throws JepException

Description copied from class: Console

Performs the required operation on a node. Typically, evaluates the node and prints the value.

Overrides:

processEquation in class Console

Parameters:

node - Node representing expression

Returns:

The result of the calculation

Throws:

JepException - if a Parse or evaluation error

setMonitor

public void setMonitor(String[] args)

Description copied from class: Console

Sets up monitoring of the call tree. Calls Console.setEvaluator(Evaluator) with a MonitoringEvaluator, sub-classes may need to override this method disable this feature.

Overrides:

setMonitor in class Console

Parameters:

args - second argument can be one of "off", "calls" or "times"

setEvaluator

public void setEvaluator(Evaluator ev)

Description copied from class: Console

Sets the evaluator used. Default method simple calls Jep.setComponent(com.singularsys.jep.JepComponent) with the evaluator.

Overrides:

setEvaluator in class Console

Parameters:

ev - the evaluator to use

showCalls

public void showCalls()

Description copied from class: Console

Shows a summary of function, operator, variable and constant calls.

Overrides:

showCalls in class Console

showTree

public void showTree()

Description copied from class: Console

Shows the call tree with counts and times.

Overrides:

showTree in class Console

toString

public String toString(Object o)

Description copied from class: Console

Return string representation of object. Used the doubleFormat if specified.

Overrides:

toString in class FieldConsole

Parameters:

o -

Returns:

main

public static void main(String[] args)

Creates a new Console object and calls run()