|
|
|||||||||||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.lmu.ifi.dbs.elki.logging.AbstractLoggable
de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractSimilarityFunction<O,D>
de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPreprocessorBasedSimilarityFunction<O,SharedNearestNeighborsPreprocessor<O,D>,IntegerDistance>
de.lmu.ifi.dbs.elki.distance.similarityfunction.SharedNearestNeighborSimilarityFunction<O,D>
O
- object typeD
- distance typepublic class SharedNearestNeighborSimilarityFunction<O extends DatabaseObject,D extends Distance<D>>
Field Summary |
---|
Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction |
---|
INFINITY_PATTERN |
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable |
---|
optionHandler |
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable |
---|
debug, logger |
Constructor Summary | |
---|---|
SharedNearestNeighborSimilarityFunction()
Provides a SharedNearestNeighborSimilarityFunction with a pattern defined to accept Strings that define a non-negative Integer. |
Method Summary | |
---|---|
protected static int |
countSharedNeighbors(SortedSet<Integer> neighbors1,
SortedSet<Integer> neighbors2)
|
AssociationID<SortedSet<Integer>> |
getAssociationID()
Returns the association ID for the association to be set by the preprocessor. |
String |
getDefaultPreprocessorClassName()
Returns the name of the default preprocessor. |
String |
getPreprocessorDescription()
Returns the description for the preprocessor parameter. |
Class<SharedNearestNeighborsPreprocessor<O,D>> |
getPreprocessorSuperClass()
Returns the super class for the preprocessor parameter. |
IntegerDistance |
infiniteDistance()
Provides an infinite distance. |
boolean |
isInfiniteDistance(IntegerDistance distance)
Returns true, if the given distance is an infinite distance, false otherwise. |
boolean |
isNullDistance(IntegerDistance distance)
Returns true, if the given distance is a null distance, false otherwise. |
boolean |
isUndefinedDistance(IntegerDistance distance)
Returns true, if the given distance is an undefined distance, false otherwise. |
IntegerDistance |
nullDistance()
Provides a null distance. |
IntegerDistance |
similarity(Integer id1,
Integer id2)
Returns the similarity between the two objects specified by their object ids. |
IntegerDistance |
undefinedDistance()
Provides an undefined distance. |
IntegerDistance |
valueOf(String pattern)
Provides a measurement suitable to this measurement function based on the given pattern. |
Methods inherited from class de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPreprocessorBasedSimilarityFunction |
---|
getPreprocessor, setDatabase, setParameters |
Methods inherited from class de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractSimilarityFunction |
---|
similarity, similarity |
Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction |
---|
getDatabase, matches, requiredInputPattern, setRequiredInputPattern, shortDescription |
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable |
---|
addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable |
Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable |
---|
debugFine, debugFiner, debugFinest, exception, progress, verbose, warning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction |
---|
requiredInputPattern |
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable |
---|
checkGlobalParameterConstraints, collectOptions, getParameters, shortDescription |
Constructor Detail |
---|
public SharedNearestNeighborSimilarityFunction()
Method Detail |
---|
public IntegerDistance similarity(Integer id1, Integer id2)
SimilarityFunction
id1
- first object idid2
- second object id
protected static int countSharedNeighbors(SortedSet<Integer> neighbors1, SortedSet<Integer> neighbors2)
public IntegerDistance infiniteDistance()
MeasurementFunction
public boolean isInfiniteDistance(IntegerDistance distance)
MeasurementFunction
distance
- the distance to be tested on infinity
public boolean isNullDistance(IntegerDistance distance)
MeasurementFunction
distance
- the distance to be tested whether it is a null distance
public boolean isUndefinedDistance(IntegerDistance distance)
MeasurementFunction
distance
- the distance to be tested whether it is undefined
public IntegerDistance nullDistance()
MeasurementFunction
public IntegerDistance undefinedDistance()
MeasurementFunction
public IntegerDistance valueOf(String pattern) throws IllegalArgumentException
MeasurementFunction
pattern
- a pattern defining a similarity suitable to this
measurement function
IllegalArgumentException
- if the given pattern is not compatible with the requirements
of this measurement functionpublic AssociationID<SortedSet<Integer>> getAssociationID()
PreprocessorClient
AssociationID.SHARED_NEAREST_NEIGHBORS_SET
public String getDefaultPreprocessorClassName()
PreprocessorClient
SharedNearestNeighborsPreprocessor
public String getPreprocessorDescription()
PreprocessorClient
public Class<SharedNearestNeighborsPreprocessor<O,D>> getPreprocessorSuperClass()
PreprocessorClient
SharedNearestNeighborsPreprocessor
|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |