Package de.lmu.ifi.dbs.elki.utilities

Utility and helper classes - commonly used data structures, output formatting, exceptions, ...

See: Description

Interface Summary

Interface	Description
InspectionUtilFrequentlyScanned	Marker interface for classes that are frequently scanned for by the UI (i.e.

Class Summary

Class	Description
Base64	Class to wrap various Base64 encoders that could be available.
BitsUtil	Utilities for bit operations.
ClassGenericsUtil	Utils for handling class instantiation especially with respect to Java generics.
ConstantObject<D extends ConstantObject<D>>	ConstantObject provides a parent class for constant objects, that are immutable and unique by class and name.
DatabaseUtil	Class with Database-related utility functions such as centroid computation, covariances etc.
DatabaseUtil.CollectionFromRelation<O>	Collection view on a database that retrieves the objects when needed.
DatabaseUtil.RelationObjectIterator<O>	Iterator class that retrieves the given objects from the database.
ELKIServiceLoader	Class that emulates the behavior of an java ServiceLoader, except that the classes are not automatically instantiated.
FileUtil	Various static helper methods to deal with files and file names.
FormatUtil	Utility methods for output formatting of various number objects
HandlerList<H>	Manages a list of handlers for objects.
InspectionUtil	A collection of inspection-related utility functions.
InspectionUtil.ClassSorter	Sort classes by their class name.
InspectionUtil.DirClassIterator	Class to iterate over a directory tree.
InspectionUtil.JarClassIterator	Class to iterate over a Jar file.
QueryStatistic	Provides some statistics about queries using a filter-refinement architecture.
Util	This class collects various static helper methods.
Util.ForwardComparator	Regular comparator.

Package de.lmu.ifi.dbs.elki.utilities Description

Utility and helper classes - commonly used data structures, output formatting, exceptions, ...

Specialized utility classes (which often collect static utility methods only) can be found in other places of ELKI as well, as seen below.

Important utility function collections:

• Basic and low-level:
  • Util: Miscellaneous utility functions.
  • PairUtil: for Pair Comparators.
  • LoggingUtil: simple logging access.
  • MathUtil: Mathematics utility functions.
  • VectorUtil: Vector and Matrix functions.
  • SpatialUtil: Spatial MBR computations (intersection, union etc.).
  • ByteArrayUtil: byte array processing (low-level IO via byte arrays).
  • FileUtil: File and file name utility functions.
  • ClassGenericsUtil: Generic classes (instantiation, arrays of arrays, sets that require safe but unchecked casts).
• Database-related:
  • TypeUtil: Data type utility functions and common type definitions.
  • QueryUtil: Database Query API simplifications.
  • DBIDUtil: Database ID DBID handling.
  • DataStoreUtil: Data storage layer (like Maps).
  • DatabaseUtil: database utility functions (centroid etc.).
  • DistanceUtil: distance functions related (min, max for Distances).
  • ResultUtil: result processing functions (e.g. extracting sub-results).
• Output-related:
  • FormatUtil: output formatting.
  • HTMLUtil: HTML (with XML DOM) generation.
  • SVGUtil: SVG generation (XML DOM based).
  • BatikUtil: Apache Batik SVG utilities (coordinate transforms screen to canvas).
  • VisualizerUtil: Visualizer handling.
• Specialized:
  • ImageUtil: image handling.
  • OptionUtil: Managing parameter settings
  • InspectionUtil: class and classpath inspection.
  • DocumentationUtil: documentation extraction from annotations.
  • PageFileUtil: reporting page file accesses.
  • RStarTreeUtil: reporting page file accesses.