com.gzoltar.report.metrics

Class AbstractMetric

java.lang.Object

com.gzoltar.report.metrics.AbstractMetric

All Implemented Interfaces:

IMetric

Direct Known Subclasses:

AbstractMetricReducer, AmbiguityMetric, CoverageMetric, DDUMetric, DistinctTransactionsRho, EntropyMetric, RhoMetric, SimpsonMetric

public abstract class AbstractMetric
extends Object
implements IMetric

Constructor Summary

Constructors

Constructor and Description
AbstractMetric()

Method Summary

Modifier and Type	Method and Description
abstract double	calculate(ISpectrum spectrum)
boolean	equals(Object obj)
IFormula	getFormula()
abstract String	getName()
int	hashCode()
protected double	log2(double value)
protected double	normalize(double value) Normalize a value using Andrea's normalization function.
protected double	normalize(double min, double max, double value) Normalizes a value.
boolean	requireFormula()
void	setFormula(IFormula formula)
protected boolean	validMatrix(ISpectrum spectrum)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMetric

public AbstractMetric()

Method Detail

calculate

public abstract double calculate(ISpectrum spectrum)

Specified by:

calculate in interface IMetric

Returns:

getName

public abstract String getName()

Specified by:

getName in interface IMetric

Returns:

requireFormula

public boolean requireFormula()

Specified by:

requireFormula in interface IMetric

Returns:

setFormula

public void setFormula(IFormula formula)

Specified by:

setFormula in interface IMetric

getFormula

public IFormula getFormula()

Specified by:

getFormula in interface IMetric

Returns:

validMatrix

protected boolean validMatrix(ISpectrum spectrum)

Parameters:

spectrum -

Returns:

log2

protected double log2(double value)

Parameters:

value -

Returns:

normalize

protected double normalize(double min,
                           double max,
                           double value)

Normalizes a value.

Parameters:

min -

max -

value - to normalize

Returns:

normalized value

normalize

protected double normalize(double value)
                    throws IllegalArgumentException

Normalize a value using Andrea's normalization function.

Parameters:

value - a double.

Returns:

a double.

Throws:

IllegalArgumentException - if any.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object