Class Sequence

Namespace

NOpenNLP.Tools.Util

Assembly

NOpenNLP.Tools.dll

Represents a weighted sequence of outcomes.

public class Sequence : IComparable<Sequence>

Inheritance

object

Sequence

Implements

IComparable<Sequence>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

Sequence()

Creates a new sequence of outcomes.

public Sequence()

Sequence(Sequence)

public Sequence(Sequence s)

Parameters

s Sequence

Sequence(Sequence, string, double)

public Sequence(Sequence s, string outcome, double p)

Parameters

s Sequence

outcome string

p double

Sequence(IList<string>)

public Sequence(IList<string> outcomes)

Parameters

outcomes IList<string>

Properties

Outcomes

Returns a list of outcomes for this sequence.

public virtual IList<string> Outcomes { get; }

Property Value

IList<string>

a list of outcomes.

Probs

Returns an array of probabilities associated with the outcomes of this sequence.

public virtual double[] Probs { get; }

Property Value

double[]

an array of probabilities.

Score

Returns the score of this sequence.

public virtual double Score { get; }

Property Value

double

The score of this sequence.

Methods

Add(string, double)

Adds an outcome and probability to this sequence.

public virtual void Add(string outcome, double p)

Parameters

outcome string

the outcome to be added.

p double

the probability associated with this outcome.

CompareTo(Sequence)

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 virtual int CompareTo(Sequence s)

Parameters

s Sequence

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.

GetProbs(double[])

Populates an array with the probabilities associated with the outcomes of this sequence.

public virtual void GetProbs(double[] ps)

Parameters

ps double[]

a pre-allocated array to use to hold the values of the probabilities of the outcomes for this sequence.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.