> {
/**
* Parameter to indicate the number of neighbors to be taken into account
* for the shared-nearest-neighbor similarity.
*
*
* Default value: 1
*
*
* Key: {@code sharedNearestNeighbors}
*
*/
public static final OptionID NUMBER_OF_NEIGHBORS_ID = new OptionID("sharedNearestNeighbors", "number of nearest neighbors to consider (at least 1)");
/**
* Parameter to indicate the distance function to be used to ascertain the
* nearest neighbors.
*
*
* Default value: {@link EuclideanDistanceFunction}
*
*
* Key: {@code SNNDistanceFunction}
*
*/
public static final OptionID DISTANCE_FUNCTION_ID = new OptionID("SNNDistanceFunction", "the distance function to asses the nearest neighbors");
/**
* Holds the number of nearest neighbors to be used.
*/
protected int numberOfNeighbors;
/**
* Hold the distance function to be used.
*/
protected DistanceFunction distanceFunction;
/**
* Constructor.
*
* @param numberOfNeighbors Number of neighbors
* @param distanceFunction Distance function
*/
public Factory(int numberOfNeighbors, DistanceFunction distanceFunction) {
super();
this.numberOfNeighbors = numberOfNeighbors;
this.distanceFunction = distanceFunction;
}
@Override
public SharedNearestNeighborPreprocessor instantiate(Relation relation) {
return new SharedNearestNeighborPreprocessor<>(relation, numberOfNeighbors, distanceFunction);
}
/**
* Get the number of neighbors
*
* @return NN size
*/
@Override
public int getNumberOfNeighbors() {
return numberOfNeighbors;
}
@Override
public TypeInformation getInputTypeRestriction() {
return distanceFunction.getInputTypeRestriction();
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
/**
* Holds the number of nearest neighbors to be used.
*/
protected int numberOfNeighbors;
/**
* Hold the distance function to be used.
*/
protected DistanceFunction distanceFunction;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
final IntParameter numberOfNeighborsP = new IntParameter(NUMBER_OF_NEIGHBORS_ID);
numberOfNeighborsP.addConstraint(CommonConstraints.GREATER_EQUAL_ONE_INT);
if(config.grab(numberOfNeighborsP)) {
numberOfNeighbors = numberOfNeighborsP.getValue();
}
final ObjectParameter> distanceFunctionP = new ObjectParameter<>(DISTANCE_FUNCTION_ID, DistanceFunction.class, EuclideanDistanceFunction.class);
if(config.grab(distanceFunctionP)) {
distanceFunction = distanceFunctionP.instantiateClass(config);
}
}
@Override
protected Factory makeInstance() {
return new Factory<>(numberOfNeighbors, distanceFunction);
}
}
}
}