org.matheclipse.core.eval.interfaces

Class AbstractCoreFunctionEvaluator

java.lang.Object

org.matheclipse.core.eval.interfaces.AbstractCoreFunctionEvaluator

All Implemented Interfaces:

ICoreFunctionEvaluator, IFunctionEvaluator, IEvaluator

Direct Known Subclasses:

And, Append, AppendTo, Apply, Array, ArrayQ, AtomQ, Attributes, Blank, Block, Break, Cases, Catch, Chop, Clear, ClearAll, Collect, Compile, Complex, CompoundExpression, Condition, Continue, Count, Defer, Definition, Delete, DeleteCases, Depth, DirectedInfinity, Do, Drop, Element, EvenQ, Exponent, First, FixedPoint, Flatten, Fold, FoldList, For, FreeQ, FullForm, Function, Get, Head, Hold, HoldForm, Identity, If, Implies, Insert, IntegerQ, JavaForm, Last, LeafCount, Length, ListQ, MatchQ, MathMLForm, MemberQ, MessageName, Module, N, Nand, Nest, NestList, NestWhileList, Nor, NumberQ, NumericQ, OddQ, Or, Package, Part, Pattern, Position, Prepend, PrependTo, Print, Quiet, Rational, Reap, Refine, Rest, Return, Riffle, RotateLeft, RotateRight, Rule, RuleDelayed, Set, SetAttributes, SetDelayed, Sow, Switch, Take, TeXForm, Throw, TimeConstrained, Trace, Unevaluated, Unique, Unset, UpSet, UpSetDelayed, ValueQ, Which, While

public abstract class AbstractCoreFunctionEvaluator
extends java.lang.Object
implements ICoreFunctionEvaluator

Abstract interface for built-in Symja functions. The numericEval() method delegates to the evaluate()

Constructor Summary

Constructors

Constructor and Description
AbstractCoreFunctionEvaluator()

Method Summary

Modifier and Type	Method and Description
abstract IExpr	evaluate(IAST ast, EvalEngine engine) Symbolic evaluation of a function.
IExpr	numericEval(IAST ast, EvalEngine engine) Numeric evaluation of a function.
void	setUp(ISymbol symbol) Evaluate built-in rules and define Attributes for a function.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCoreFunctionEvaluator

public AbstractCoreFunctionEvaluator()

Method Detail

numericEval

public IExpr numericEval(IAST ast,
                         EvalEngine engine)

Numeric evaluation of a function. ast.get(0) (or alternatively ast.head()) contains the head (i.e. the function symbol) of this abstract syntax tree (AST).
From ast.arg1() to ast.get(n) the ast contains the first to n-th argument of the function (alternatively you get the first to fifth argument with the methods arg1(), arg2(),... arg5()).
If necessary use the methods from the Validate class to check the number or types of arguments in the evaluate method.

Specified by:

numericEval in interface IFunctionEvaluator

Parameters:

ast - the abstract syntax tree (AST) which should be evaluated

engine - the users current evaluation engine

Returns:

the evaluated object or null, if evaluation isn't possible

See Also:

Validate, IExpr.head(), IAST.arg1(), IAST.arg2(), IAST.arg3()

setUp

public void setUp(ISymbol symbol)
           throws SyntaxError

Evaluate built-in rules and define Attributes for a function.

Specified by:

setUp in interface IEvaluator

Parameters:

symbol - the symbol which should be set up

Throws:

SyntaxError

evaluate

public abstract IExpr evaluate(IAST ast,
                               EvalEngine engine)

Symbolic evaluation of a function. ast.get(0) (or alternatively ast.head()) contains the head (i.e. the function symbol) of this abstract syntax tree (AST).
From ast.arg1() to ast.get(n) the ast contains the first to n-th argument of the function (alternatively you get the first to fifth argument with the methods arg1(), arg2(),... arg5()).
If necessary use the methods from the Validate class to check the number or types of arguments in the evaluate method.
Note: if the symbolic evaluation isn't possible or no result is found the evaluate method returns with a null value without throwing an exception!

Specified by:

evaluate in interface IFunctionEvaluator

Parameters:

ast - the abstract syntax tree (AST) which should be evaluated

engine - the users current evaluation engine

Returns:

the evaluated object or null, if evaluation isn't possible

See Also:

Validate, IExpr.head(), IAST.arg1(), IAST.arg2(), IAST.arg3()