Package com.singularsys.jep.functions

Class Dot

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.jep.functions.Dot

All Implemented Interfaces:

PostfixMathCommandI, Serializable

public class Dot
extends BinaryFunction

The dot product of two vectors.

Since:

Jep 4.1 can work with List<?>.

Author:

Richard Morris

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.functions.BinaryFunction

BinaryFunction.BiFunctionWithException<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Add	add
protected final Multiply	mul

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
Dot()	Constructor, uses the standard Add and Multiply.
Dot(Add add, Multiply mul)	Constructor with specific implementations

Method Summary

Modifier and Type	Method	Description
Object	dot(Object param1, Object param2)
Object	dot(List<?> v1, List<?> v2)
Object	eval(Object l, Object r)	Evaluate the function

Methods inherited from class com.singularsys.jep.functions.BinaryFunction

instanceOf, instanceOf, instanceOf, instanceOf, run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, checkNumberOfParameters, getDescription, getDescription, getDescriptionWithType, getName, getNumberOfParameters, setCurNumberOfParameters, setDescription, setName, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

add

protected final Add add

mul

protected final Multiply mul

Constructor Details

Dot

public Dot()

Constructor, uses the standard Add and Multiply.

Dot

public Dot(Add add,
 Multiply mul)

Constructor with specific implementations

Parameters:

add - implementation for addition

mul - implementation for multiplication

Since:

Jep 4.1

Method Details

eval

public Object eval(Object l,
 Object r)
            throws EvaluationException

Description copied from class: BinaryFunction

Evaluate the function

Specified by:

eval in class BinaryFunction

Parameters:

l - lhs argument

r - rhs argument

Returns:

the results

Throws:

EvaluationException - if the function cannot be evaluated.

dot

public Object dot(Object param1,
 Object param2)
           throws EvaluationException

Throws:

EvaluationException

dot

public Object dot(List<?> v1,
 List<?> v2)
           throws EvaluationException

Throws:

EvaluationException