org.matheclipse.core.eval.interfaces

Interface IFunctionEvaluator

All Superinterfaces:

IEvaluator

All Known Subinterfaces:

ICoreFunctionEvaluator

All Known Implementing Classes:

AbortRubi, Abs, AbstractArg1, AbstractArg12, AbstractArg2, AbstractArgMultiple, AbstractCoreFunctionEvaluator, AbstractEvaluator, AbstractFunctionEvaluator, AbstractMatrix1Expr, AbstractMatrix1Matrix, AbstractNonOrderlessArgMultiple, AbstractTrigArg1, AddTo, And, Apart, Append, AppendTo, Apply, ArcCos, ArcCosh, ArcCot, ArcCoth, ArcCsc, ArcCsch, ArcSec, ArcSech, ArcSin, ArcSinh, ArcTan, ArcTanh, Arg, Array, ArrayDepth, ArrayQ, AtomQ, Attributes, BernoulliB, BesselJ, Binomial, Blank, Block, Boole, BooleanConvert, BooleanMinimize, Break, Cancel, CartesianProduct, Cases, CatalanNumber, Catch, Ceiling, CharacteristicPolynomial, ChebyshevT, ChebyshevU, ChessboardDistance, Chop, Clear, ClearAll, Coefficient, CoefficientList, CoefficientRules, Collect, Compile, Complement, Complex, ComplexExpand, ComposeList, CompoundExpression, Condition, Conjugate, ConjugateTranspose, ConstantArray, Continue, ContinuedFraction, CoprimeQ, Cos, Cosh, CosIntegral, Cot, Coth, Count, Cross, Csc, Csch, Curl, D, Decrement, Default, Defer, Definition, Delete, DeleteCases, DeleteDuplicates, Denominator, Depth, Derivative, Det, DiagonalMatrix, DigitQ, Dimensions, DirectedInfinity, Discriminant, Distribute, Divergence, DivideBy, Divisible, Divisors, Do, Dot, Drop, DSolve, Eigenvalues, Eigenvectors, Element, Eliminate, Equal, Equivalent, Erf, EuclidianDistance, EulerE, EulerPhi, EvenQ, Exp, Expand, ExpandAll, Exponent, ExtendedGCD, Extract, Factor, Factorial, Factorial2, FactorInteger, FactorSquareFree, FactorSquareFreeList, FactorTerms, Fibonacci, FindRoot, First, Fit, FixedPoint, Flatten, Floor, Fold, FoldList, For, FractionalPart, FreeQ, FresnelC, FresnelS, FrobeniusSolve, FromCharacterCode, FromContinuedFraction, FullForm, FullSimplify, Function, Gamma, Gather, GCD, GeometricMean, Get, Greater, GreaterEqual, GroebnerBasis, HarmonicNumber, Haversine, Head, HermiteH, HilbertMatrix, Hold, HoldForm, Horner, HornerForm, Identity, IdentityMatrix, If, Im, Implies, Increment, Inner, Insert, IntegerExponent, IntegerPart, IntegerPartitions, IntegerQ, Integrate, InterpolatingFunction, InterpolatingPolynomial, Intersection, Inverse, InverseErf, InverseFunction, InverseHaversine, JacobiMatrix, JacobiSymbol, JavaForm, Join, KOrderlessPartitions, KPartitions, LaguerreL, LaplaceTransform, Last, LCM, LeafCount, LegendreP, Length, Less, LessEqual, LetterQ, Level, Limit, LinearProgramming, LinearSolve, ListQ, Log, Log10, Log2, LowerCaseQ, LUDecomposition, ManhattanDistance, Map, MapAll, MapAt, MapThread, MatchQ, MathMLForm, MatrixPower, MatrixQ, MatrixRank, Max, Mean, Median, MemberQ, MessageName, Min, Mod, Module, MoebiusMu, MonomialList, Most, Multinomial, N, Names, Nand, Negative, Nest, NestList, NestWhile, NestWhileList, NextPrime, NFourierTransform, NIntegrate, NMaximize, NMinimize, NonCommutativeMultiply, NonNegative, Nor, Norm, Normalize, Not, NRoots, NSolve, NullSpace, NumberQ, Numerator, NumericQ, OddQ, Or, Order, OrderedQ, Out, Outer, Package, PadLeft, PadRight, Part, Partition, Pattern, Permutations, Piecewise, Plot, Plot3D, Plus, Pochhammer, PolynomialExtendedGCD, PolynomialGCD, PolynomialLCM, PolynomialQ, PolynomialQuotient, PolynomialQuotientRemainder, PolynomialRemainder, Position, Positive, PossibleZeroQ, Power, PowerExpand, PowerMod, PreDecrement, PreIncrement, Prepend, PrependTo, Prime, PrimeQ, PrimitiveRoots, Print, Product, ProductLog, PseudoInverse, Quiet, Quotient, RandomInteger, RandomReal, RandomSample, Range, Rational, Rationalize, Re, Reap, Refine, Replace, ReplaceAll, ReplaceList, ReplacePart, ReplaceRepeated, Rest, Resultant, Return, Reverse, Riffle, RootIntervals, Roots, RotateLeft, RotateRight, Round, RowReduce, Rule, RuleDelayed, SameQ, Scan, Sec, Sech, Select, Set, SetAttributes, SetDelayed, Sign, SignCmp, Simplify, Sin, Sinc, SingularValueDecomposition, Sinh, SinIntegral, Solve, Sort, Sow, Sqrt, SquaredEuclidianDistance, SquareFreeQ, StirlingS2, StringDrop, StringJoin, StringLength, StringTake, Subfactorial, Subsets, SubtractFrom, Sum, Surd, Switch, SyntaxLength, SyntaxQ, Table, Take, Tan, Tanh, Taylor, TeXForm, Thread, Through, Throw, TimeConstrained, Times, TimesBy, Timing, ToCharacterCode, Together, ToString, Total, ToUnicode, Tr, Trace, Transpose, TrigExpand, TrigReduce, TrigToExp, TrueQ, Tuples, Unequal, Unevaluated, Union, Unique, UnitStep, UnitVector, UnsameQ, Unset, UpperCaseQ, UpSet, UpSetDelayed, ValueQ, VandermondeMatrix, Variables, VectorAngle, VectorQ, Which, While, Xor

public interface IFunctionEvaluator
extends IEvaluator

Common interface for built-in Symja functions.

Method Summary

Modifier and Type	Method and Description
IExpr	evaluate(IAST ast, EvalEngine engine) Symbolic evaluation of a function.
IExpr	numericEval(IAST ast, EvalEngine engine) Numeric evaluation of a function.

Methods inherited from interface org.matheclipse.core.interfaces.IEvaluator

setUp

Method Detail

evaluate

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!

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()

numericEval

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.

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()