org.matheclipse.core.builtin.function

Class Package

java.lang.Object

org.matheclipse.core.eval.interfaces.AbstractCoreFunctionEvaluator

org.matheclipse.core.builtin.function.Package

All Implemented Interfaces:

ICoreFunctionEvaluator, IFunctionEvaluator, IEvaluator

public class Package
extends AbstractCoreFunctionEvaluator

Package[{<list of public package rule headers>}, {<list of rules in this package>}}

Constructor Summary

Constructors

Constructor and Description
Package()

Method Summary

Modifier and Type	Method and Description
static void	evalPackage(IAST publicSymbols, IAST list, EvalEngine engine)
IExpr	evaluate(IAST ast, EvalEngine engine) Symbolic evaluation of a function.
static void	loadPackage(EvalEngine engine, java.io.Reader is) Load a package from the given reader
IExpr	numericEval(IAST functionList, 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

Package

public Package()

Method Detail

evaluate

public IExpr evaluate(IAST ast,
                      EvalEngine engine)

Description copied from class: AbstractCoreFunctionEvaluator

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 AbstractCoreFunctionEvaluator

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

evalPackage

public static void evalPackage(IAST publicSymbols,
                               IAST list,
                               EvalEngine engine)

numericEval

public IExpr numericEval(IAST functionList,
                         EvalEngine engine)

Description copied from class: AbstractCoreFunctionEvaluator

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

Overrides:

numericEval in class AbstractCoreFunctionEvaluator

Parameters:

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

Description copied from class: AbstractCoreFunctionEvaluator

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

Specified by:

setUp in interface IEvaluator

Overrides:

setUp in class AbstractCoreFunctionEvaluator

Parameters:

symbol - the symbol which should be set up

loadPackage

public static void loadPackage(EvalEngine engine,
                               java.io.Reader is)

Load a package from the given reader

Parameters:

is -