ByLabelOutlier (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.outlier.trivial.ByLabelOutlier

All Implemented Interfaces:

elki.Algorithm, OutlierAlgorithm
```
@Priority(-100)
public class ByLabelOutlier
extends java.lang.Object
implements OutlierAlgorithm
```
Trivial algorithm that marks outliers by their label. Can be used as reference algorithm in comparisons.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ByLabelOutlier.Par
Parameterization class.
- Nested classes/interfaces inherited from interface elki.Algorithm
  elki.Algorithm.Utils

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`DEFAULT_PATTERN`	The default pattern to use.
`(package private) java.util.regex.Pattern`	`pattern`	The pattern we match with.

Constructor Summary

Constructors
Constructor Description

ByLabelOutlier()
Constructor.

ByLabelOutlier(java.util.regex.Pattern pattern)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OutlierResult`	`autorun(elki.database.Database database)`
`elki.data.type.TypeInformation[]`	`getInputTypeRestriction()`
`OutlierResult`	`run(elki.database.relation.Relation<?> relation)`	Run the algorithm

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PATTERN
```
public static final java.lang.String DEFAULT_PATTERN
```
    The default pattern to use.
    
    See Also:
    
    Constant Field Values
  - pattern
```
final java.util.regex.Pattern pattern
```
    The pattern we match with.
- Constructor Detail
  - ByLabelOutlier
```
public ByLabelOutlier(java.util.regex.Pattern pattern)
```
    Constructor.
    
    Parameters:
    
    pattern - Pattern to match with.
  - ByLabelOutlier
```
public ByLabelOutlier()
```
    Constructor.
- Method Detail
  - getInputTypeRestriction
```
public elki.data.type.TypeInformation[] getInputTypeRestriction()
```
    Specified by:
    
    getInputTypeRestriction in interface elki.Algorithm
  - autorun
```
public OutlierResult autorun(elki.database.Database database)
```
    Specified by:
    
    autorun in interface elki.Algorithm
    
    Specified by:
    
    autorun in interface OutlierAlgorithm
  - run
```
public OutlierResult run(elki.database.relation.Relation<?> relation)
```
    Run the algorithm
    
    Parameters:
    
    relation - Relation to process.
    
    Returns:
    
    Result