net.sourceforge.cilib.measurement.single.diversity
Class Diversity

java.lang.Object
  net.sourceforge.cilib.measurement.single.diversity.Diversity

All Implemented Interfaces:

Serializable, Measurement, Cloneable

Direct Known Subclasses:

AverageDiversityAroundAllEntities

public class Diversity
extends Object
implements Measurement

TODO: Add JavaDoc.

Author:

Olusegun Olorunda, gpampara

See Also:

Serialized Form

Field Summary

protected DistanceMeasure	distanceMeasure
protected NormalisationParameter	normalisationParameter
protected CenterInitialisationStrategy	populationCenter

Constructor Summary

Diversity()

Diversity(Diversity other)

Method Summary

Diversity	getClone() Create a cloned copy of the current object and return it.
DistanceMeasure	getDistanceMeasure()
String	getDomain() Get the domain string representing what this measurement's results will conform to.
NormalisationParameter	getNormalisationParameter()
CenterInitialisationStrategy	getPopulationCenter()
Type	getValue(Algorithm algorithm) Get the value of the measurement.
void	setDistanceMeasure(DistanceMeasure distanceMeasure)
void	setNormalisationParameter(NormalisationParameter normalizationParameter)
void	setPopulationCenter(CenterInitialisationStrategy populationCenter)

Methods inherited from class java.lang.Object

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

Field Detail

distanceMeasure

protected DistanceMeasure distanceMeasure

populationCenter

protected CenterInitialisationStrategy populationCenter

normalisationParameter

protected NormalisationParameter normalisationParameter

Constructor Detail

Diversity

public Diversity()

Diversity

public Diversity(Diversity other)

Method Detail

getClone

public Diversity getClone()

Description copied from interface: Measurement

Create a cloned copy of the current object and return it. In general the created copy will be a deep copy of the provided instance. As a result this operation an be quite expensive if used incorrectly.

Specified by:

getClone in interface Measurement

Specified by:

getClone in interface Cloneable

Returns:

An exact clone of the current object instance.

See Also:

Object.clone()

getDomain

public String getDomain()

Description copied from interface: Measurement

Get the domain string representing what this measurement's results will conform to.

Specified by:

getDomain in interface Measurement

Returns:

The Domain String representing the represenation of the measurement

getValue

public Type getValue(Algorithm algorithm)

Description copied from interface: Measurement

Get the value of the measurement. The represenation of the measurement will be based on the domain string defined Measurement.getDomain()

Specified by:

getValue in interface Measurement

Parameters:

algorithm - The algorithm to obtain the measurement from.

Returns:

The Type representing the value of the measurement.

getDistanceMeasure

public DistanceMeasure getDistanceMeasure()

Returns:

the distanceMeasure

setDistanceMeasure

public void setDistanceMeasure(DistanceMeasure distanceMeasure)

Parameters:

distanceMeasure - the distanceMeasure to set

getNormalisationParameter

public NormalisationParameter getNormalisationParameter()

Returns:

the normalisationParameter

setNormalisationParameter

public void setNormalisationParameter(NormalisationParameter normalizationParameter)

Parameters:

normalisationParameter - the normalisationParameter to set

getPopulationCenter

public CenterInitialisationStrategy getPopulationCenter()

Returns:

the populationCenter

setPopulationCenter

public void setPopulationCenter(CenterInitialisationStrategy populationCenter)

Parameters:

populationCenter - the populationCenter to set