blob: ae221ca76271fa83f26c65070ff6524a532e68a9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
package de.lmu.ifi.dbs.elki.algorithm;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import de.lmu.ifi.dbs.elki.data.type.TypeInformation;
import de.lmu.ifi.dbs.elki.database.Database;
import de.lmu.ifi.dbs.elki.result.Result;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable;
/**
* <p>
* Specifies the requirements for any algorithm that is to be executable by the
* main class.
* </p>
* <p/>
* <p>
* Any implementation needs not to take care of input nor output, parsing and so
* on. Those tasks are performed by the framework. An algorithm simply needs to
* ask for parameters that are algorithm specific.
* </p>
* <p/>
* <p>
* <b>Note:</b> Any implementation is supposed to provide a constructor without
* parameters (default constructor).
* </p>
*
* @author Arthur Zimek
*/
public interface Algorithm extends Parameterizable {
/**
* Runs the algorithm.
*
* @param database the database to run the algorithm on
* @return the Result computed by this algorithm
*/
Result run(Database database);
/**
* Get the input type restriction used for negotiating the data query.
*
* @return Type restriction
*/
public TypeInformation[] getInputTypeRestriction();
}
|
