Class ComparableEvent

Namespace
NOpenNLP.Tools.Ml.Model
Assembly
NOpenNLP.Tools.dll

A maxent event representation which we can use to sort based on the predicates indexes contained in the events.

public class ComparableEvent : IComparable<ComparableEvent>
Inheritance
ComparableEvent
Implements
Inherited Members

Constructors

ComparableEvent(int, int[], float[]?)

A maxent event representation which we can use to sort based on the predicates indexes contained in the events.

public ComparableEvent(int oc, int[] pids, float[]? values = null)

Parameters

oc int
pids int[]
values float[]

Properties

Outcome

public int Outcome { get; set; }

Property Value

int

PredIndexes

public int[] PredIndexes { get; set; }

Property Value

int[]

Seen

The number of times this event has been seen.

public int Seen { get; set; }

Property Value

int

Values

public float[]? Values { get; set; }

Property Value

float[]

Methods

CompareTo(ComparableEvent?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(ComparableEvent? ce)

Parameters

ce ComparableEvent

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value Meaning
Less than zero This instance precedes other in the sort order.
Zero This instance occurs in the same position in the sort order as other.
Greater than zero This instance follows other in the sort order.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.