org.matheclipse.core.eval.interfaces

Class AbstractTrigArg1

java.lang.Object

org.matheclipse.core.eval.interfaces.AbstractEvaluator

org.matheclipse.core.eval.interfaces.AbstractFunctionEvaluator

org.matheclipse.core.eval.interfaces.AbstractArg1

org.matheclipse.core.eval.interfaces.AbstractTrigArg1

All Implemented Interfaces:

IFunctionEvaluator, IEvaluator

Direct Known Subclasses:

Abs, ArcCos, ArcCosh, ArcCot, ArcCoth, ArcCsc, ArcCsch, ArcSec, ArcSech, ArcSin, ArcSinh, ArcTanh, Arg, CatalanNumber, Cos, Cosh, CosIntegral, Cot, Coth, Csc, Csch, Divisors, Erf, EulerE, EulerPhi, Factorial, Factorial2, FactorInteger, Fibonacci, FresnelC, FresnelS, Gamma, InverseErf, Mean, Median, MoebiusMu, PrimitiveRoots, Sec, Sech, Sin, Sinc, Sinh, SinIntegral, Subfactorial, Tan, Tanh

public abstract class AbstractTrigArg1
extends AbstractArg1

Base class for functions with 1 argument (i.e. Sin, Cos...) with Attributes Listable and NumericFunction

Constructor Summary

Constructors

Constructor and Description
AbstractTrigArg1()

Method Summary

Modifier and Type	Method and Description
IExpr	e1ComplexArg(org.apache.commons.math4.complex.Complex c)
IExpr	e1DblArg(double d)
IExpr	evaluate(IAST ast, EvalEngine engine) Symbolic evaluation of a function.
IExpr	evaluateArg1(IExpr arg1)
IExpr	numericEval(IAST ast, EvalEngine engine) Numeric evaluation of a function.

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

e1ApcomplexArg, e1ApfloatArg, e1ComArg, e1FraArg, e1FunArg, e1IntArg, e1ObjArg, e1SymArg

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

createRuleFromMethod, getNormalizedNegativeExpression, getNormalizedNegativeExpression, getPeriodicParts, getPureImaginaryPart, getRuleAST, initSerializedRules, isNegativeExpression, setUp

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTrigArg1

public AbstractTrigArg1()

Method Detail

evaluate

public IExpr evaluate(IAST ast,
                      EvalEngine engine)

Description copied from class: AbstractFunctionEvaluator

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

Overrides:

evaluate in class AbstractArg1

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

public IExpr numericEval(IAST ast,
                         EvalEngine engine)

Description copied from class: AbstractEvaluator

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

e1DblArg

public IExpr e1DblArg(double d)

Overrides:

e1DblArg in class AbstractArg1

e1ComplexArg

public IExpr e1ComplexArg(org.apache.commons.math4.complex.Complex c)

Overrides:

e1ComplexArg in class AbstractArg1

evaluateArg1

public IExpr evaluateArg1(IExpr arg1)