Class Prediction

Represents a single alignment prediction

Hierarchy

Prediction

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Prediction(alignment: Alignment): Prediction

- Defined in core/Prediction.ts:58
Instantiates a new alignment prediction

Parameters
- alignment: Alignment
  
  the alignment for which a prediction will be calculated
Returns Prediction

Properties

Private predictedAlignment

predictedAlignment: Alignment

Private scores

scores: NumberObject

Accessors

alignment

get alignment(): Alignment

- Defined in core/Prediction.ts:24
Returns the alignment represented by this prediction

Returns Alignment

confidence

get confidence(): number

- Defined in core/Prediction.ts:48
Convenience method for retrieving the prediction confidence.

Returns number

key

get key(): string

- Defined in core/Prediction.ts:56
Returns the prediction key

Returns string

scoreKeys

get scoreKeys(): string[]

- Defined in core/Prediction.ts:16
Returns an array of score keys

Returns string[]

source

get source(): Ngram

- Defined in core/Prediction.ts:32
Convenience method to access the source n-gram of the alignment

Returns Ngram

target

get target(): Ngram

- Defined in core/Prediction.ts:40
Convenience method to access the target n-gram of the alignment.

Returns Ngram

Methods

getScore

getScore(key: string): number

- Defined in core/Prediction.ts:98
Reads a single score from this prediction.

Parameters
- key: string
  
  the score key
Returns number
- the score value

getScores

getScores(): NumberObject

- Defined in core/Prediction.ts:118
Returns a copy of the prediction scores

Returns NumberObject

hasScore

hasScore(key: string): boolean

- Defined in core/Prediction.ts:110
Checks if the score key exists.

Parameters
- key: string
Returns boolean

intersects

intersects(prediction: Prediction): boolean

- Defined in core/Prediction.ts:127
Checks if this prediction intersects with another prediction.

Parameters
- prediction: Prediction
Returns boolean

setScore

setScore(key: string, value: number): void

- Defined in core/Prediction.ts:74
Sets a score for this prediction

Parameters
- key: string
  
  the score key
- value: number
  
  the score value
Returns void

setScores

setScores(scores: NumberObject): void

- Defined in core/Prediction.ts:86
Convenience method for setting multiple scores at a time

Parameters
- scores: NumberObject
  
  an object of scores
Returns void

toJSON

toJSON(verbose?: boolean): object

- Defined in core/Prediction.ts:168
Outputs the prediction to json

Parameters
- Default value verbose: boolean = false
  
  print full metadata.
Returns object

toString

toString(): string

- Defined in core/Prediction.ts:158
Prints a user friendly form of the prediction

Returns string

Generated using TypeDoc