Class BaseFilter Abstract

A base class for implementing probailistic filters

author: Thomas Minier
author: Arnaud Grall

Hierarchy

BaseFilter

Index

Properties

Constructors

constructor

Methods

Accessors

Properties

_hashing

_hashing: Hashing

_rng

_rng: PRNG

_seed

_seed: number

Constructors

constructor

new BaseFilter(): BaseFilter

- Defined in src/base-filter.ts:39
Returns BaseFilter

Methods

Static fromJSON

fromJSON(json: JSON): any

- Defined in src/base-filter.ts:91
Load an Object from a provided JSON object

Parameters
- json: JSON
  
  the JSON object to load
Returns any
Return the Object loaded from the provided JSON object

nextInt32

nextInt32(): number

- Defined in src/base-filter.ts:73
Return a next random seeded int32 integer

Returns number

saveAsJSON

saveAsJSON(): any

- Defined in src/base-filter.ts:81
Save the current structure as a JSON

Returns any

Accessors

random

get random(): PRNG

- Defined in src/base-filter.ts:65
Get a function used to draw random number

Returns PRNG
A factory function used to draw random integer

seed

get seed(): number
set seed(seed: number): void

- Defined in src/base-filter.ts:48
Get the seed used in this structure

Returns number
- Defined in src/base-filter.ts:56
Set the seed for this structure

Parameters
- seed: number
  
  the new seed that will be used in this structure
Returns void

Generated using TypeDoc