weka.core.pmml

Class NormContinuous

java.lang.Object

weka.core.pmml.Expression

weka.core.pmml.NormContinuous

All Implemented Interfaces:

Serializable

public class NormContinuous
extends Expression

Class encapsulating a NormContinuous Expression.

Version:

$Revision 1.0 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_fieldIndex The index of the field
protected String	m_fieldName The name of the field to use
protected double[]	m_linearNormNorm norm values for the LinearNorm entries
protected double[]	m_linearNormOrig original values for the LinearNorm entries
protected boolean	m_mapMissingDefined True if a replacement for missing values has been specified
protected double	m_mapMissingTo The value of the missing value replacement (if defined)
protected weka.core.pmml.MiningFieldMetaInfo.Outlier	m_outlierTreatmentMethod Outlier treatment method (default = asIs)

Fields inherited from class weka.core.pmml.Expression

m_fieldDefs, m_opType

Constructor Summary

Constructors

Constructor and Description
NormContinuous(Element normCont, FieldMetaInfo.Optype opType, ArrayList<Attribute> fieldDefs)

Method Summary

Modifier and Type	Method and Description
protected Attribute	getOutputDef() Return the structure of the result of applying this Expression as an Attribute.
double	getResult(double[] incoming) Get the result of evaluating the expression.
String	getResultCategorical(double[] incoming) Always throws an Exception since the result of NormContinuous must be continuous.
double	getResultInverse(double[] incoming) Compute the inverse of the normalization (i.e.
void	setFieldDefs(ArrayList<Attribute> fieldDefs) Set the field definitions for this Expression to use
String	toString(String pad)

Methods inherited from class weka.core.pmml.Expression

getExpression, getExpression, getFieldDef, getFieldDefIndex, getOptype, getResultContinuous, toString

Methods inherited from class java.lang.Object

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

Field Detail

m_fieldName

protected String m_fieldName

The name of the field to use

m_fieldIndex

protected int m_fieldIndex

The index of the field

m_mapMissingDefined

protected boolean m_mapMissingDefined

True if a replacement for missing values has been specified

m_mapMissingTo

protected double m_mapMissingTo

The value of the missing value replacement (if defined)

m_outlierTreatmentMethod

protected weka.core.pmml.MiningFieldMetaInfo.Outlier m_outlierTreatmentMethod

Outlier treatment method (default = asIs)

m_linearNormOrig

protected double[] m_linearNormOrig

original values for the LinearNorm entries

m_linearNormNorm

protected double[] m_linearNormNorm

norm values for the LinearNorm entries

Constructor Detail

NormContinuous

public NormContinuous(Element normCont,
                      FieldMetaInfo.Optype opType,
                      ArrayList<Attribute> fieldDefs)
               throws Exception

Throws:

Exception

Method Detail

setFieldDefs

public void setFieldDefs(ArrayList<Attribute> fieldDefs)
                  throws Exception

Set the field definitions for this Expression to use

Overrides:

setFieldDefs in class Expression

Parameters:

fieldDefs - the field definitions to use

Throws:

Exception - if there is a problem setting the field definitions

getOutputDef

protected Attribute getOutputDef()

Return the structure of the result of applying this Expression as an Attribute.

Specified by:

getOutputDef in class Expression

Returns:

the structure of the result of applying this Expression as an Attribute.

getResult

public double getResult(double[] incoming)
                 throws Exception

Get the result of evaluating the expression. In the case of a continuous optype, a real number is returned; in the case of a categorical/ordinal optype, the index of the nominal value is returned as a double.

Specified by:

getResult in class Expression

Parameters:

incoming - the incoming parameter values

Returns:

the result of normalizing the input field

Throws:

Exception - if there is a problem computing the result

getResultInverse

public double getResultInverse(double[] incoming)

Compute the inverse of the normalization (i.e. map back to a unormalized value).

Parameters:

incoming - the incoming parameter values

Returns:

the unormalized value

getResultCategorical

public String getResultCategorical(double[] incoming)
                            throws Exception

Always throws an Exception since the result of NormContinuous must be continuous.

Specified by:

getResultCategorical in class Expression

Parameters:

incoming - the incoming parameter values

Returns:

the result of evaluating the expression

Throws:

Exception - always

toString

public String toString(String pad)

Overrides:

toString in class Expression