net.sourceforge.cilib.measurement
Interface Measurement

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AlignmentVisualizer, AreaUnderROC, AverageDiversityAroundAllEntities, BestParticlePosition, BestPositionBoundViolations, CompositeMeasurement, ConvergedDimensions, DcPatternCount, DgPatternCount, Diameter, DimensionBoundViolationsPerParticle, Diversity, Diversity, DtPatternCount, DvPatternCount, Efn2RNAFitness, ErrorDg, ErrorDt, ErrorDv, EuclideanDiversityAroundGBest, Fitness, FitnessEvaluations, FunctionOptimisationError, GenericFunctionMeasurement, HydrogenBondFitness, Iterations, MathewsFitness, MethewsFitness, MovingPeaksOfflineErrorMeasurement, MovingPeaksOfflinePerformanceMeasurement, MultipleFitness, MultipleSolutions, MultiPopulationFitness, NNOutput, NormalisedDiversity, NumberOfClustersFormed, ParetoOptimalFront, ParetoOptimalSet, ParticleBoundViolations, ParticlePositions, PbestBoundViolations, PercentageComplete, Restarts, RNAAccuracyMeasurement, RNAFitness, RNAStructureMeasurement, RobelOverfittingRho, SimpleRNAFitness, Solution, SpatialExtent, StateAwareMeasurement, StoredFitness, Time, ViennaRNAFitness

public interface Measurement
extends Cloneable

All measurements must implement this interface. The measurment must return the value of what it is measuring given the algorithm that it is measuring.

Author:

Edwin Peer, Gary Pampara

Method Summary

Measurement	getClone() Create a cloned copy of the current object and return it.
String	getDomain() Get the domain string representing what this measurement's results will conform to.
Type	getValue(Algorithm algorithm) Get the value of the measurement.

Method Detail

getClone

Measurement getClone()

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 Cloneable

Returns:

An exact clone of the current object instance.

See Also:

Object.clone()

getDomain

String getDomain()

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

Returns:

The Domain String representing the represenation of the measurement

getValue

Type getValue(Algorithm algorithm)

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

Parameters:

algorithm - The algorithm to obtain the measurement from.

Returns:

The Type representing the value of the measurement.