Class Bag<T>

A bag, i.e. a set using a custom comparison function, keeping only minimal values.

Warning: once added, elements in the set should not change -- no comparison and filtering would be done in such a case.

Type Parameters

T extends Comparable<T>

Index

Constructors

Properties

Accessors

Methods

[iterator] add addOnly merge prune update updateOnly values from

Constructors

constructor

new Bag<T extends Comparable<T>>(): Bag<T>
Type Parameters
- T extends Comparable<T>
Returns Bag<T>

Properties

`Protected` `Readonly`inner

inner: { dominated: boolean; val: T }[] = []

Accessors

size

get size(): number
O(n)...

Returns number
- Defined in src/structures/base.ts:246

Methods

[iterator]

"[iterator]"(): Generator<T, void, unknown>
Returns Generator<T, void, unknown>
- Defined in src/structures/base.ts:355

add

add(el: T): { added: boolean; pruned: number }
Adds (O(n^2)) an element in the bag, keeping only minimal values.
Parameters
- el: T
  Element to add in the bag
Returns { added: boolean; pruned: number }
Wether the element has been added or not, the number of pruned elements
- Defined in src/structures/base.ts:293

addOnly

addOnly(el: T): boolean
Adds (O(n)) an element in the bag, marking new dominated values but not removing them, see add.
Parameters
- el: T
  Element to add in the bag
Returns boolean
Wether the element has been added or not
- Defined in src/structures/base.ts:255

merge

merge(b: Bag<T>): { added: number; pruned: number }
adds (O(n^2)) everything from another bag in this bag.
Parameters
- b: Bag<T>
  Bag to merge from
Returns { added: number; pruned: number }
Number of added and pruned elements
- Defined in src/structures/base.ts:305

prune

prune(): number
Removes (O(n^2)) dominated elements

Returns number
#Removed elements
- Defined in src/structures/base.ts:277

update

update(oldEl: T, newEl: T): number
Updates an element in the bag, removing it if it's being dominated, and removing possible dominated elements
Parameters
- oldEl: T
  Element to update currently in the bag
- newEl: T
  New element to put in its place
Returns number
Number of pruned elements, possibly including the updated element
- Defined in src/structures/base.ts:348

updateOnly

updateOnly(oldEl: T, newEl: T): boolean
Updates an element in the bag, marking dominated elements
Parameters
- oldEl: T
  Element to update currently in the bag
- newEl: T
  New element to put in its place
Returns boolean
Wether the updated element is now dominated or not
- Defined in src/structures/base.ts:321

values

values(): Generator<T, void, unknown>
Returns Generator<T, void, unknown>
- Defined in src/structures/base.ts:359

`Static`from

from<T extends Comparable<T>>(bag: Bag<T>): Bag<T>
Create (O(n)) a new bag from another. Does NOT copy elements -- they have the same reference.
Type Parameters
- T extends Comparable<T>
Parameters
- bag: Bag<T>
Returns Bag<T>
- Defined in src/structures/base.ts:232