org.matheclipse.core.builtin.function

Class NumericQ

java.lang.Object

org.matheclipse.core.eval.interfaces.AbstractCoreFunctionEvaluator

org.matheclipse.core.builtin.function.NumericQ

All Implemented Interfaces:

java.util.function.Predicate<IExpr>, ICoreFunctionEvaluator, IFunctionEvaluator, IEvaluator

public class NumericQ
extends AbstractCoreFunctionEvaluator
implements java.util.function.Predicate<IExpr>

Returns True, if the given expression is a numeric function or value.

Constructor Summary

Constructors

Constructor and Description
NumericQ() Constructor for the unary predicate

Method Summary

Modifier and Type	Method and Description
IExpr	evaluate(IAST ast, EvalEngine engine) Returns True if the first argument is a numeric object; False otherwise
static INumber	getNumberNumericQ(IExpr arg1) Deprecated. use IExpr.evalNumber() instead
static ISignedNumber	getSignedNumberNumericQ(IExpr arg1) Deprecated. use IExpr.evalSignedNumber() instead
void	setUp(ISymbol symbol) Evaluate built-in rules and define Attributes for a function.
boolean	test(IExpr arg)

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

numericEval

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

NumericQ

public NumericQ()

Constructor for the unary predicate

Method Detail

test

public boolean test(IExpr arg)

Specified by:

test in interface java.util.function.Predicate<IExpr>

evaluate

public IExpr evaluate(IAST ast,
                      EvalEngine engine)

Returns True if the first argument is a numeric object; False otherwise

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

setUp

public void setUp(ISymbol symbol)
           throws SyntaxError

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

Throws:

SyntaxError

getSignedNumberNumericQ

@Deprecated
public static ISignedNumber getSignedNumberNumericQ(IExpr arg1)

Deprecated. use IExpr.evalSignedNumber() instead

Do a numerical evaluation of the given expression, if arg1.isNumericFunction() is true. Return a ISignedNumber if the evaluation result is a ISignedNumber and null in all other cases

Parameters:

arg1 - an expression

Returns:

a signed number if possible, otherwise return null

getNumberNumericQ

@Deprecated
public static INumber getNumberNumericQ(IExpr arg1)

Deprecated. use IExpr.evalNumber() instead

Do a numerical evaluation of the given expression, if arg1.isNumericFunction() is true. Return a INumber if the evaluation result is a INumber and null in all other cases

Parameters:

arg1 - an expression

Returns:

a number if possible