org.openimaj.math.model.fit.residuals

Class DistanceComparatorResidual<I,D,M extends Model<I,D>>

java.lang.Object

org.openimaj.math.model.fit.residuals.AbstractResidualCalculator<I,D,M>

org.openimaj.math.model.fit.residuals.DistanceComparatorResidual<I,D,M>

Type Parameters:

I - type of independent data

D - type of dependent data

M - type of model

All Implemented Interfaces:

ResidualCalculator<I,D,M>

public class DistanceComparatorResidual<I,D,M extends Model<I,D>>
extends AbstractResidualCalculator<I,D,M>

An implementation of a ResidualCalculator that uses a DistanceComparator to compute the error between the predicted and observed data point. In the case that the given DistanceComparator is a similarity measure, the similarities will be multiplied by -1 to ensure error increases with decreasing similarity.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected DistanceComparator<D>	comparator

Fields inherited from class org.openimaj.math.model.fit.residuals.AbstractResidualCalculator

model

Constructor Summary

Constructors

Constructor and Description
DistanceComparatorResidual(DistanceComparator<D> comparator) Construct with the given DistanceComparator.

Method Summary

Modifier and Type	Method and Description
double	computeResidual(IndependentPair<I,D> data) Compute the residual for a single point

Methods inherited from class org.openimaj.math.model.fit.residuals.AbstractResidualCalculator

computeResiduals, setModel

Methods inherited from class java.lang.Object

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

Field Detail

comparator

protected DistanceComparator<D> comparator

Constructor Detail

DistanceComparatorResidual

public DistanceComparatorResidual(DistanceComparator<D> comparator)

Construct with the given DistanceComparator.

Parameters:

comparator - the DistanceComparator

Method Detail

computeResidual

public double computeResidual(IndependentPair<I,D> data)

Description copied from interface: ResidualCalculator

Compute the residual for a single point

Parameters:

data - the data

Returns:

the error