org.tribuo.anomaly

Class Event

java.lang.Object

org.tribuo.anomaly.Event

All Implemented Interfaces:

Serializable, Output<Event>

public final class Event
extends Object
implements Output<Event>

An Output representing either an Event.EventType.ANOMALOUS or an Event.EventType.EXPECTED event.

Event trainers are allowed to throw IllegalArgumentException if they are supplied an Event.EventType.ANOMALOUS at training time. It's noted in the documentation if they do support training from anomalous and expected data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.EventType The type of event.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_SCORE The default score of events.

Constructor Summary

Constructors

Constructor and Description
Event(Event.EventType type) Constructs a new event of the specified type with the default score of DEFAULT_SCORE.
Event(Event.EventType type, double score) Constructs a new event of the specified type and score.

Method Summary

Modifier and Type	Method and Description
Event	copy() Deep copy of the output up to it's immutable state.
boolean	equals(Object o)
boolean	fullEquals(Event o) Compares other to this output.
double	getScore() Get a real valued score for this label.
String	getSerializableForm(boolean includeConfidence) Returns "EventType" or "EventType,score=eventScore".
Event.EventType	getType() Gets the event type.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SCORE

public static final double DEFAULT_SCORE

The default score of events.

See Also:

Constant Field Values

Constructor Detail

Event

public Event(Event.EventType type,
             double score)

Constructs a new event of the specified type and score.

Parameters:

type - The event type.

score - The event score.

Event

public Event(Event.EventType type)

Constructs a new event of the specified type with the default score of DEFAULT_SCORE.

Parameters:

type - The event type.

Method Detail

getScore

public double getScore()

Get a real valued score for this label.

If the score is not set then it returns DEFAULT_SCORE.

Returns:

The predicted score for this label.

getType

public Event.EventType getType()

Gets the event type.

Returns:

An event type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fullEquals

public boolean fullEquals(Event o)

Description copied from interface: Output

Compares other to this output. Uses all score values and the strings.

Specified by:

fullEquals in interface Output<Event>

Parameters:

o - Another output instance.

Returns:

True if the other instance has value equality to this instance. False otherwise.

toString

public String toString()

Overrides:

toString in class Object

copy

public Event copy()

Description copied from interface: Output

Deep copy of the output up to it's immutable state.

Specified by:

copy in interface Output<Event>

Returns:

A copy of the output.

getSerializableForm

public String getSerializableForm(boolean includeConfidence)

Returns "EventType" or "EventType,score=eventScore".

Specified by:

getSerializableForm in interface Output<Event>

Parameters:

includeConfidence - Include whatever confidence score the label contains, if known.

Returns:

A String form suitable for serialization.