Class Related

Hierarchy

Related

Index

Constructors

Properties

debug documents_ options_ stems_ tfidfs_

Accessors

documents numParts serializer stemmer stems tfidfs tokenizer weights

Methods

prepare process rank reset serialize stem tokenize

Constructors

constructor

new Related(documents: any[], options: Options): Related
Parameters
- documents: any[]
- options: Options
Returns Related
- Defined in related.ts:36

Properties

`Private` debug

debug: boolean = false

`Private` documents_

documents_: any

`Private` options_

options_: Options

`Private` stems_

stems_: string[][][]

`Private` tfidfs_

tfidfs_: TfIdf[]

Accessors

documents

get documents(): any
Returns any
- Defined in related.ts:49

numParts

get numParts(): number
Returns number
- Defined in related.ts:61

serializer

get serializer(): serializer
Returns serializer
- Defined in related.ts:73
set serializer(serializer: serializer): void
Parameters
- serializer: serializer
Returns void
- Defined in related.ts:77

stemmer

get stemmer(): Stemmer
Returns Stemmer
- Defined in related.ts:91
set stemmer(stemmer: Stemmer): void
Parameters
- stemmer: Stemmer
Returns void
- Defined in related.ts:95

stems

get stems(): string[][][]
Returns string[][][]
- Defined in related.ts:65

tfidfs

get tfidfs(): TfIdf[]
Returns TfIdf[]
- Defined in related.ts:69

tokenizer

get tokenizer(): Tokenizer
Returns Tokenizer
- Defined in related.ts:82
set tokenizer(tokenizer: Tokenizer): void
Parameters
- tokenizer: Tokenizer
Returns void
- Defined in related.ts:86

weights

get weights(): number[]
Returns number[]
- Defined in related.ts:53
set weights(weights: number[]): void
Parameters
- weights: number[]
Returns void
- Defined in related.ts:57

Methods

`Private` prepare

prepare(): void
Returns void
- Defined in related.ts:105

`Private` process

process(document: any): string[][]
Convert the document into parts, each having an array of stems or words
Parameters
- document: any
Returns string[][]
- Defined in related.ts:153

rank

rank(document: any): {
    absolute: number;
    document: any;
    relative: number;
}[]
Parameters
- document: any
Returns {
    absolute: number;
    document: any;
    relative: number;
}[]
- Defined in related.ts:176

`Private` reset

reset(): void
Returns void
- Defined in related.ts:100

serialize

serialize(document: any): string[]
Serialize according the serializer where an object is serialized into an array of strings based upon specific parts of the document such as title, summary, etc.
Parameters
- document: any
Returns string[]
- Defined in related.ts:128

stem

stem(parts: string[][]): string[][]
Run the stemmer over the words.
Parameters
- parts: string[][]
Returns string[][]
- Defined in related.ts:142

tokenize

tokenize(parts: string[]): string[][]
Tokenize the individual serialized parts of the document.
Parameters
- parts: string[]
Returns string[][]
- Defined in related.ts:135

Generated using TypeDoc