Package com.yahoo.searchlib.rankingexpression.rule

Enum Class Function

java.lang.Object

java.lang.Enum<Function>

com.yahoo.searchlib.rankingexpression.rule.Function

All Implemented Interfaces:

Serializable, Comparable<Function>, Constable

public enum Function
extends Enum<Function>
implements Serializable

A scalar function

Author:

bratseth

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
abs
acos
asin
atan
atan2
bit
ceil
cos
cosh
elu
erf
exp
fabs
floor
fmod
hamming
isNan
ldexp
log
log10
max
min
pow
relu
round
sigmoid
sign
sin
sinh
sqrt
square
tan
tanh

Method Summary

Modifier and Type	Method	Description
int	arity()	Returns the number of arguments this function takes
abstract double	evaluate(double x, double y)	Perform the function on the input
static Function	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Function[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

abs

public static final Function abs

acos

public static final Function acos

asin

public static final Function asin

atan

public static final Function atan

ceil

public static final Function ceil

cos

public static final Function cos

cosh

public static final Function cosh

elu

public static final Function elu

exp

public static final Function exp

fabs

public static final Function fabs

floor

public static final Function floor

isNan

public static final Function isNan

log

public static final Function log

log10

public static final Function log10

relu

public static final Function relu

round

public static final Function round

sigmoid

public static final Function sigmoid

sign

public static final Function sign

sin

public static final Function sin

sinh

public static final Function sinh

square

public static final Function square

sqrt

public static final Function sqrt

tan

public static final Function tan

tanh

public static final Function tanh

erf

public static final Function erf

atan2

public static final Function atan2

fmod

public static final Function fmod

ldexp

public static final Function ldexp

max

public static final Function max

min

public static final Function min

pow

public static final Function pow

bit

public static final Function bit

hamming

public static final Function hamming

Method Details

values

public static Function[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Function valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

evaluate

public abstract double evaluate(double x,
 double y)

Perform the function on the input

arity

public int arity()

Returns the number of arguments this function takes