weka.core.pmml

Class NormDiscrete

java.lang.Object

weka.core.pmml.Expression

weka.core.pmml.NormDiscrete

All Implemented Interfaces:

Serializable

public class NormDiscrete
extends Expression

Class encapsulating a NormDiscrete Expression. Creates an indicator for a particular discrete value.

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 Attribute	m_field The actual attribute itself
protected int	m_fieldIndex The index of the attribute
protected String	m_fieldName The name of the field to lookup our value in
protected String	m_fieldValue The actual value (as a String) that will correspond to an output of 1
protected int	m_fieldValueIndex If we are referring to a nominal (rather than String) attribute then this holds the index of the value in question.
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)

Fields inherited from class weka.core.pmml.Expression

m_fieldDefs, m_opType

Constructor Summary

Constructors

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

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 NormDiscrete must be continuous.
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 lookup our value in

m_field

protected Attribute m_field

The actual attribute itself

m_fieldIndex

protected int m_fieldIndex

The index of the attribute

m_fieldValue

protected String m_fieldValue

The actual value (as a String) that will correspond to an output of 1

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_fieldValueIndex

protected int m_fieldValueIndex

If we are referring to a nominal (rather than String) attribute then this holds the index of the value in question. Will be faster than searching for the value each time.

Constructor Detail

NormDiscrete

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

Constructor. Reads the field name and field value for this NormDiscrete Expression.

Parameters:

normDisc - the Element encapsulating this NormDiscrete

opType - the optype for this expression (taken from either the enclosing DefineFunction or DerivedField)

fieldDefs - an ArrayList of Attributes for the fields that this Expression might need to access enclosing DefineFunction or DerivedField)

Throws:

Exception - if there is a problem parsing this Apply Expression

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 evaluating the expression

Throws:

Exception - if there is a problem computing the result

getResultCategorical

public String getResultCategorical(double[] incoming)
                            throws Exception

Always throws an Exception since the result of NormDiscrete 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