Package org.apache.pdfbox.pdmodel.common.function

Class PDFunctionTypeIdentity

java.lang.Object

org.apache.pdfbox.pdmodel.common.function.PDFunction

org.apache.pdfbox.pdmodel.common.function.PDFunctionTypeIdentity

All Implemented Interfaces:

COSObjectable

public class PDFunctionTypeIdentity
extends PDFunction

The identity function.

Author:

Tilman Hausherr

Constructor Summary

Constructors

Constructor	Description
PDFunctionTypeIdentity(COSBase function)

Method Summary

Modifier and Type	Method	Description
float[]	eval(float[] input)	Evaluates the function at the given input.
int	getFunctionType()	Returns the function type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.pdfbox.pdmodel.common.function.PDFunction

clipToRange, clipToRange, create, eval, getCOSObject, getDomainForInput, getNumberOfInputParameters, getNumberOfOutputParameters, getPDStream, getRangeForOutput, getRangeValues, interpolate, setDomainValues, setRangeValues

Constructor Detail

PDFunctionTypeIdentity

public PDFunctionTypeIdentity(COSBase function)

Method Detail

getFunctionType

public int getFunctionType()

Description copied from class: PDFunction

Returns the function type. Possible values are: 0 - Sampled function 2 - Exponential interpolation function 3 - Stitching function 4 - PostScript calculator function

Specified by:

getFunctionType in class PDFunction

Returns:

the function type.

eval

public float[] eval(float[] input)
             throws java.io.IOException

Description copied from class: PDFunction

Evaluates the function at the given input. ReturnValue = f(input)

Specified by:

eval in class PDFunction

Parameters:

input - The array of input values for the function. In many cases will be an array of a single value, but not always.

Returns:

The of outputs the function returns based on those inputs. In many cases will be an array of a single value, but not always.

Throws:

java.io.IOException - an IOExcpetion is thrown if something went wrong processing the function.

toString

public java.lang.String toString()

Overrides:

toString in class PDFunction