Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FrequencyTable<K>

An object that can be used to efficiently store and manage the frequencies of the specified keys.

Type parameters

  • K: string | number

Hierarchy

  • AbstractCollection<[K, number]>
    • FrequencyTable

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

count

  • get count(): number

isEmpty

  • get isEmpty(): boolean

total

  • get total(): number

Methods

[iterator]

  • [iterator](): Iterator<[K, number], any, undefined>

clear

  • clear(): void

decrement

  • decrement(key: K): void

  • If the frequency of the specified key is positive, decreases it by 1. Otherwise (if it's 0), doesn't do anything.

    remarks

    Complexity:

    • Time complexity: O(1)
    • Space complexity: O(1)

    Parameters

    • key: K

      The key whose frequency to decrement.

    Returns void

frequencyOf

  • frequencyOf(key: K): number

  • Retrieves the frequency of the specified key. Returns 0, if the key doesn't exist in the table.

    remarks

    Complexity:

    • Time complexity: O(1)
    • Space complexity: O(1)

    Parameters

    • key: K

      The key whose frequency to decrement.

    Returns number

    A non-negative integer indicating the frequency of the specified key.

increment

  • increment(key: K): void

  • Increases the frequency of the specified key by 1.

    remarks

    Complexity:

    • Time complexity: O(1)
    • Space complexity: O(1)

    Parameters

    • key: K

      The key whose frequency to increment.

    Returns void

toArray

  • toArray(): [K, number][]

  • Converts the collection into a plain array.

    remarks

    Complexity:

    • Time complexity: O(N)
    • Space complexity: O(N)

    where:

    • N: number of items in the collection

    Returns [K, number][]

    A new array containing all the items in the collection.

Generated using TypeDoc