org.encog.ml.importance

Class FeatureRank

java.lang.Object

org.encog.ml.importance.FeatureRank

All Implemented Interfaces:

java.lang.Comparable<FeatureRank>

public class FeatureRank
extends java.lang.Object
implements java.lang.Comparable<FeatureRank>

The ranking/importance of an individual feature.

Constructor Summary

Constructors

Constructor and Description
FeatureRank(java.lang.String theName) Construct the feature ranking.

Method Summary

Modifier and Type	Method and Description
void	addWeight(double theWeight) Add weight to the total importance of this feature.
int	compareTo(FeatureRank o)
double	getImportancePercent()
java.lang.String	getName()
double	getTotalWeight()
void	setImportancePercent(double importancePercent) Set the importance percent.
void	setTotalWeight(double totalWeight) Set the total weight.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureRank

public FeatureRank(java.lang.String theName)

Construct the feature ranking.

Parameters:

theName - The name of the feature.

Method Detail

getName

public java.lang.String getName()

Returns:

The name of this feature.

addWeight

public void addWeight(double theWeight)

Add weight to the total importance of this feature.

Parameters:

theWeight - The weight to add.

getTotalWeight

public double getTotalWeight()

Returns:

The total weight.

setTotalWeight

public void setTotalWeight(double totalWeight)

Set the total weight.

Parameters:

totalWeight - The total weight.

getImportancePercent

public double getImportancePercent()

Returns:

The importance percent.

setImportancePercent

public void setImportancePercent(double importancePercent)

Set the importance percent.

Parameters:

importancePercent - The importance percent.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(FeatureRank o)

Specified by:

compareTo in interface java.lang.Comparable<FeatureRank>