org.apache.pig.builtin

Class DoubleBase

java.lang.Object

org.apache.pig.EvalFunc<java.lang.Double>

org.apache.pig.builtin.Base

org.apache.pig.builtin.DoubleBase

Direct Known Subclasses:

ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, DoubleAbs, EXP, FLOOR, LOG, LOG10, SIN, SINH, SQRT, TAN, TANH

public abstract class DoubleBase
extends Base

base class for math udfs that return Double value

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pig.EvalFunc

EvalFunc.SchemaType

Field Summary

Fields inherited from class org.apache.pig.EvalFunc

log, pigLogger, reporter, returnType

Constructor Summary

Constructors

Constructor and Description
DoubleBase()

Method Summary

Modifier and Type	Method and Description
java.lang.Double	exec(Tuple input) java level API
java.util.List<FuncSpec>	getArgToFuncMapping() Allow a UDF to specify type specific implementations of itself.

Methods inherited from class org.apache.pig.builtin.Base

allowCompileTimeCalculation, outputSchema

Methods inherited from class org.apache.pig.EvalFunc

addCredentials, finish, getCacheFiles, getInputSchema, getLoadCaster, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, getSchemaType, getShipFiles, isAsynchronous, needEndOfAllInputProcessing, progress, setEndOfAllInput, setInputSchema, setPigLogger, setReporter, setUDFContextSignature, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleBase

public DoubleBase()

Method Detail

exec

public java.lang.Double exec(Tuple input)
                      throws java.io.IOException

java level API

Specified by:

exec in class EvalFunc<java.lang.Double>

Parameters:

input - expects a tuple with a single Double value

Returns:

output returns a Double value

Throws:

java.io.IOException

getArgToFuncMapping

public java.util.List<FuncSpec> getArgToFuncMapping()
                                             throws FrontendException

Description copied from class: EvalFunc

Allow a UDF to specify type specific implementations of itself. For example, an implementation of arithmetic sum might have int and float implementations, since integer arithmetic performs much better than floating point arithmetic. Pig's typechecker will call this method and using the returned list plus the schema of the function's input data, decide which implementation of the UDF to use.

Overrides:

getArgToFuncMapping in class EvalFunc<java.lang.Double>

Returns:

A List containing FuncSpec objects representing the EvalFunc class which can handle the inputs corresponding to the schema in the objects. Each FuncSpec should be constructed with a schema that describes the input for that implementation. For example, the sum function above would return two elements in its list:

1. FuncSpec(this.getClass().getName(), new Schema(new Schema.FieldSchema(null, DataType.DOUBLE)))
2. FuncSpec(IntSum.getClass().getName(), new Schema(new Schema.FieldSchema(null, DataType.INTEGER)))

This would indicate that the main implementation is used for doubles, and the special implementation IntSum is used for ints.

Throws:

FrontendException