de.lmu.ifi.dbs.elki.utilities.optionhandling
Interface Parameterizable
- All Known Subinterfaces:
- Algorithm<O,R>, ClusteringAlgorithm<C,O>, Database<O>, DatabaseConnection<O>, DistanceFunction<O,D>, DistanceParser<O,D>, EigenPairFilter, Index<O>, KernelFunction<O,D>, LinebasedParser<O>, MeasurementFunction<O,D>, Normalization<O>, NormalizedSimilarityFunction<O,D>, Parser<O>, PreferenceVectorPreprocessor<O>, Preprocessor<O>, PreprocessorBasedMeasurementFunction<O,P,D>, PreprocessorClient<P,O>, ResultHandler<O,R>, SimilarityFunction<O,D>, SpatialDistanceFunction<V,D>
- All Known Implementing Classes:
- ABOD, AbstractAlgorithm, AbstractApplication, AbstractCorrelationDistanceFunction, AbstractDatabase, AbstractDatabaseConnection, AbstractDimensionsSelectingDoubleDistanceFunction, AbstractDistanceFunction, AbstractDoubleDistanceFunction, AbstractDoubleKernelFunction, AbstractEditDistanceFunction, AbstractFloatDistanceFunction, AbstractIntegerSimilarityFunction, AbstractKernelFunction, AbstractLocallyWeightedDistanceFunction, AbstractMeasurementFunction, AbstractMkTree, AbstractMTree, AbstractNormalization, AbstractParameterizable, AbstractParser, AbstractPreferenceVectorBasedCorrelationDistanceFunction, AbstractPreprocessorBasedDistanceFunction, AbstractPreprocessorBasedSimilarityFunction, AbstractRStarTree, AbstractSimilarityFunction, APRIORI, ArbitraryKernelFunctionWrapper, ArcCosineDistanceFunction, AttributeWiseMinMaxNormalization, AttributeWiseVarianceNormalization, BitVectorLabelParser, ByLabelClustering, ByLabelHierarchicalClustering, CacheDoubleDistanceInOnDiskMatrix, CacheFloatDistanceInOnDiskMatrix, CASH, CLIQUE, CompositeEigenPairFilter, ComputeROCCurve, COPAC, CosineDistanceFunction, CovarianceMatrixBuilder, DBSCAN, DeLiClu, DeLiCluTree, DependencyDerivator, DimensionSelectingDistanceFunction, DimensionsSelectingEuclideanDistanceFunction, DiscardResultHandler, DiSH, DiSHDistanceFunction, DiSHPreprocessor, DiskCacheBasedDoubleDistanceFunction, DiskCacheBasedFloatDistanceFunction, DistanceBasedAlgorithm, DistanceStatisticsWithClasses, DoubleVectorLabelParser, DoubleVectorLabelTransposingParser, DoubleVectorProjectionParser, DoubleVectorRandomProjectionParser, DTWDistanceFunction, DummyAlgorithm, DummyNormalization, EDRDistanceFunction, EM, ERiC, ERiCDistanceFunction, ERPDistanceFunction, EuclideanDistanceFunction, EvaluateRankingQuality, FileBasedDatabaseConnection, FileBasedDoubleDistanceFunction, FileBasedFloatDistanceFunction, FirstNEigenPairFilter, FloatVectorLabelParser, FooKernelFunction, FourC, FourCPreprocessor, FractionalSharedNearestNeighborSimilarityFunction, GeneratorXMLSpec, HiCOPreprocessor, HiSCDistanceFunction, HiSCPreprocessor, IndexDatabase, InputStreamDatabaseConnection, KDDTask, KernelBasedLocallyWeightedDistanceFunction, KernelCovarianceMatrixBuilder, KernelMatrix, KMeans, KNNDistanceOrder, KNNExplorer, KNNJoin, KnnQueryBasedHiCOPreprocessor, LCSSDistanceFunction, LimitEigenPairFilter, LinearKernelFunction, LocallyWeightedDistanceFunction, LOCI, LOF, LPNormDistanceFunction, ManhattanDistanceFunction, MaterializeDistances, MaterializeKNNPreprocessor, MetaParser, MetricalIndex, MetricalIndexDatabase, MkAppTree, MkCoPTree, MkMaxTree, MkTabTree, MTree, MultipleFileBasedDatabaseConnection, MultiRepresentedObjectNormalization, NonFlatRStarTree, NormalizingEigenPairFilter, NullAlgorithm, NumberDistanceParser, OPTICS, ORCLUS, ParameterizationFunctionLabelParser, PCABasedCorrelationDistanceFunction, PCAFilteredRunner, PCARunner, PercentageEigenPairFilter, PolynomialKernelFunction, PreDeCon, PreDeConPreprocessor, PreprocessorHandler, PROCLUS, ProgressiveEigenPairFilter, ProjectedClustering, ProjectedDBSCAN, ProjectedDBSCANPreprocessor, ProjectionParser, RandomProjectionParser, RangeQueryBasedHiCOPreprocessor, RankingQualityHistogram, RdKNNTree, RealVectorLabelParser, RelativeEigenPairFilter, RepresentationSelectingDistanceFunction, ResultROCCurveVisualizer, ResultWriter, RStarTree, SequentialDatabase, SharedNearestNeighborSimilarityFunction, SharedNearestNeighborsPreprocessor, SignificantEigenPairFilter, SimilarityAdapterAbstract, SimilarityAdapterArccos, SimilarityAdapterLinear, SimilarityAdapterLn, SLINK, SNNClustering, SOD, SparseBitVectorLabelParser, SparseFloatVectorLabelParser, SparseFloatVectorProjectionParser, SparseFloatVectorRandomProjectionParser, SpatialApproximationMaterializeKNNPreprocessor, SpatialIndex, SpatialIndexDatabase, StandAloneApplication, StandAloneInputApplication, StandardCovarianceMatrixBuilder, SubspaceDistanceFunction, TreeIndex, TrivialAllInOne, TrivialAllNoise, WeakEigenPairFilter, WeightedCovarianceMatrixBuilder, WeightedDistanceFunction
public interface Parameterizable
Interface to define the required methods for command line interaction.
- Author:
- Arthur Zimek
shortDescription
String shortDescription()
- Returns a description of the class and the required parameters.
This description should be suitable for a usage description.
- Returns:
- String a description of the class and the required parameters
setParameters
List<String> setParameters(List<String> args)
throws ParameterException
- Sets the attributes of the class accordingly to the given parameters.
Returns a new String array containing those entries of the
given array that are neither expected nor used by this
Parameterizable.
- Parameters:
args
- parameters to set the attributes accordingly to
- Returns:
- a list containing the unused parameters
- Throws:
ParameterException
- in case of wrong parameter-setting
getParameters
List<String> getParameters()
- Returns the parameter array as given to the last call
of
setParameters(List)
but without unnecessary entries.
The provided array should be suitable to call
setParameters(List)
with it resulting in the identical parameterization.
- Returns:
- the parameter array as given to the last call
of
setParameters(List)
but without unnecessary entries
checkGlobalParameterConstraints
void checkGlobalParameterConstraints()
throws ParameterException
- Checks if all global parameter constraints are kept
- Throws:
ParameterException
- if the parameters don't satisfy the parameter constraints
collectOptions
void collectOptions(List<Pair<Parameterizable,Option<?>>> collection)
- Fill the given collection with a list of available options.
- Parameters:
collection
- collection to fill