org.matheclipse.core.eval.interfaces

Class AbstractFunctionEvaluator

java.lang.Object

org.matheclipse.core.eval.interfaces.AbstractEvaluator

org.matheclipse.core.eval.interfaces.AbstractFunctionEvaluator

All Implemented Interfaces:

IFunctionEvaluator, IEvaluator

Direct Known Subclasses:

AbortRubi, AbstractArg1, AbstractArg12, AbstractArg2, AbstractMatrix1Expr, AbstractMatrix1Matrix, AddTo, Apart, ArrayDepth, BernoulliB, BesselJ, Boole, BooleanConvert, BooleanMinimize, Cancel, CartesianProduct, Ceiling, CharacteristicPolynomial, ChebyshevT, ChebyshevU, Coefficient, CoefficientList, CoefficientRules, Complement, CoprimeQ, Cross, Curl, D, Default, DeleteDuplicates, Derivative, DiagonalMatrix, DigitQ, Dimensions, Discriminant, Distribute, Divergence, Divisible, DSolve, Eliminate, Equal, Equivalent, Expand, ExpandAll, ExtendedGCD, Extract, Factor, FactorTerms, FindRoot, Fit, Floor, FractionalPart, FromCharacterCode, GeometricMean, Greater, GroebnerBasis, Haversine, HermiteH, HilbertMatrix, Horner, HornerForm, IdentityMatrix, Inner, IntegerExponent, IntegerPart, IntegerPartitions, Integrate, Intersection, InverseFunction, InverseHaversine, JacobiMatrix, Join, KOrderlessPartitions, KPartitions, LaguerreL, LaplaceTransform, LegendreP, LetterQ, Level, Limit, LinearProgramming, LinearSolve, LowerCaseQ, LUDecomposition, Map, MapAll, MapAt, MapThread, MatrixPower, MatrixQ, MatrixRank, Max, Min, MonomialList, Most, Multinomial, Names, NextPrime, NFourierTransform, NIntegrate, NMinimize, NonCommutativeMultiply, NRoots, NSolve, NullSpace, Order, OrderedQ, Outer, PadLeft, PadRight, Partition, Permutations, Piecewise, PolynomialExtendedGCD, PolynomialGCD, PolynomialLCM, PolynomialQ, PolynomialQuotientRemainder, PossibleZeroQ, PowerExpand, PowerMod, Prime, PrimeQ, RandomInteger, RandomReal, RandomSample, Rationalize, Resultant, Reverse, RootIntervals, Roots, Round, RowReduce, SameQ, Simplify, SingularValueDecomposition, Solve, Sort, SquareFreeQ, StirlingS2, StringDrop, StringJoin, StringLength, StringTake, Subsets, SyntaxLength, SyntaxQ, Table, Taylor, Thread, Through, ToCharacterCode, Together, ToString, Total, ToUnicode, TrueQ, Tuples, Union, UnitVector, UnsameQ, UpperCaseQ, VandermondeMatrix, Variables, VectorAngle, VectorQ, Xor

public abstract class AbstractFunctionEvaluator
extends AbstractEvaluator

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

Constructor Summary

Constructors

Constructor and Description
AbstractFunctionEvaluator()

Method Summary

Modifier and Type	Method and Description
void	createRuleFromMethod(ISymbol symbol, java.lang.String patternString, java.lang.String methodName) Create a rule which invokes the method name in this class instance.
abstract IExpr	evaluate(IAST ast, EvalEngine engine) Symbolic evaluation of a function.
static IExpr	getNormalizedNegativeExpression(IExpr expr) Check if the expression is canonical negative.
static IExpr	getNormalizedNegativeExpression(IExpr expr, boolean checkTimesPlus) Check if the expression is canonical negative.
static IAST	getPeriodicParts(IExpr expr, IExpr period) Try to split a periodic part from the expression: expr == part[0] + part[1] * period
static IExpr	getPureImaginaryPart(IExpr expr) Check if expr is a pure imaginary number without a real part.
IAST	getRuleAST() Get the predefined rules for this function symbol.
static void	initSerializedRules(ISymbol symbol) Initialize the serialized Rubi integration rules from ressource /ser/integrate.ser.
static boolean	isNegativeExpression(IExpr expr) Check if the expression is canonical negative.
void	setUp(ISymbol symbol) Evaluate built-in rules and define Attributes for a function.

Methods inherited from class org.matheclipse.core.eval.interfaces.AbstractEvaluator

numericEval

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFunctionEvaluator

public AbstractFunctionEvaluator()

Method Detail

getRuleAST

public IAST getRuleAST()

Get the predefined rules for this function symbol.

Returns:

null if no rules are defined

setUp

public void setUp(ISymbol symbol)
           throws SyntaxError

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

Specified by:

setUp in interface IEvaluator

Overrides:

setUp in class AbstractEvaluator

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

Specified by:

evaluate in class AbstractEvaluator

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

createRuleFromMethod

public void createRuleFromMethod(ISymbol symbol,
                                 java.lang.String patternString,
                                 java.lang.String methodName)

Create a rule which invokes the method name in this class instance.

Parameters:

symbol -

patternString -

methodName -

isNegativeExpression

public static boolean isNegativeExpression(IExpr expr)

Check if the expression is canonical negative.

Returns:

true if the first argument is canonical negative

getNormalizedNegativeExpression

public static IExpr getNormalizedNegativeExpression(IExpr expr)

Check if the expression is canonical negative.

Returns:

the negated negative expression or null if a negative expression couldn't be extracted.

getNormalizedNegativeExpression

public static IExpr getNormalizedNegativeExpression(IExpr expr,
                                                    boolean checkTimesPlus)

Check if the expression is canonical negative.

Parameters:

checkTimesPlus - check Times(...) and Plus(...) expressions

Returns:

the negated negative expression or F.NIL if a negative expression couldn't be extracted.

getPeriodicParts

public static IAST getPeriodicParts(IExpr expr,
                                    IExpr period)

Try to split a periodic part from the expression: expr == part[0] + part[1] * period

Parameters:

expr -

period -

Returns:

F.NIL if no periodicity was found or the rest at argument 1 and the factor of the period at argument 2

getPureImaginaryPart

public static IExpr getPureImaginaryPart(IExpr expr)

Check if expr is a pure imaginary number without a real part.

Parameters:

expr -

Returns:

null, if expr is not a pure imaginary number.

initSerializedRules

public static void initSerializedRules(ISymbol symbol)

Initialize the serialized Rubi integration rules from ressource /ser/integrate.ser.

Parameters:

symbol -