Package weka.core.pmml
Class DefineFunction
- java.lang.Object
-
- weka.core.pmml.Function
-
- weka.core.pmml.DefineFunction
-
- All Implemented Interfaces:
java.io.Serializable
public class DefineFunction extends Function
Class encapsulating DefineFunction (used in TransformationDictionary).- Version:
- $Revision 1.0 $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefineFunction(org.w3c.dom.Element container, weka.core.pmml.TransformationDictionary transDict)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Attribute
getOutputDef()
Get the structure of the result produced by this function.java.lang.String[]
getParameterNames()
Returns an array of the names of the parameters expected as input by this function.double
getResult(double[] incoming)
Get the result of applying this function.void
setParameterDefs(java.util.ArrayList<Attribute> paramDefs)
Set the structure of the parameters that are expected as input by this function.java.lang.String
toString()
java.lang.String
toString(java.lang.String pad)
-
Methods inherited from class weka.core.pmml.Function
getFunction, getFunction, getName
-
-
-
-
Method Detail
-
getOutputDef
public Attribute getOutputDef()
Get the structure of the result produced by this function.- Specified by:
getOutputDef
in classFunction
- Returns:
- the structure of the result produced by this function.
-
getParameterNames
public java.lang.String[] getParameterNames()
Returns an array of the names of the parameters expected as input by this function. May return null if this function can take an unbounded number of parameters (i.e. min, max, etc.).- Specified by:
getParameterNames
in classFunction
- Returns:
- an array of the parameter names or null if there are an unbounded number of parameters.
-
getResult
public double getResult(double[] incoming) throws java.lang.Exception
Get the result of applying this function.- Specified by:
getResult
in classFunction
- Parameters:
incoming
- the arguments to this function (supplied in order to match that of the parameter definitions- Returns:
- the result of applying this function. When the optype is categorical or ordinal, an index into the values of the output definition is returned.
- Throws:
java.lang.Exception
- if there is a problem computing the result of this function
-
setParameterDefs
public void setParameterDefs(java.util.ArrayList<Attribute> paramDefs) throws java.lang.Exception
Set the structure of the parameters that are expected as input by this function. This must be called before getOutputDef() is called.- Specified by:
setParameterDefs
in classFunction
- Parameters:
paramDefs
- the structure of the input parameters- Throws:
java.lang.Exception
- if the number or types of parameters are not acceptable by this function
-
-