de.lmu.ifi.dbs.elki.data.synthetic.bymodel
Interface GeneratorInterface

All Known Subinterfaces:

GeneratorInterfaceDynamic

All Known Implementing Classes:

GeneratorSingleCluster, GeneratorStatic

public interface GeneratorInterface

Interface for cluster generators

Author:

Erich Schubert

Method Summary

List<Vector>	generate(int count) Generate a specified number of points
double	getDensity(Vector p) Get the density of the given vector
int	getDim() Get dimensionality of generated data
String	getName() Get cluster name
List<Vector>	getPoints() Get points.
int	getSize() Get number of points to be generated by this generator.

Method Detail

getSize

int getSize()

Get number of points to be generated by this generator.

Returns:

cluster size

getDim

int getDim()

Get dimensionality of generated data

Returns:

dimensionality

generate

List<Vector> generate(int count)
                      throws UnableToComplyException

Generate a specified number of points

Parameters:

count - Number of points to generate

Returns:

List of generated points

Throws:

UnableToComplyException - when generation fails

getDensity

double getDensity(Vector p)

Get the density of the given vector

Parameters:

p - vector

Returns:

density

getPoints

List<Vector> getPoints()

Get points. NOTE: The list may be modified by the caller, it is not immutable. The class should not return a copy, but should allow modification. However when removing points, the called is expected to call setDiscarded.

Returns:

points

getName

String getName()

Get cluster name

Returns:

cluster name