Class HashArrayUtil

Provides extra examples of how various additional operations can be added on top of HashArray. These operations are not included with HashArray to keep it lean and mean for TrieSearch. By all means though extend HashArray and add the operations that you need.

There are tests for all operations below in ./test/hash/HAExtra.test.ts.

Constructors

constructor

Methods

average difference sample sum

Constructors

constructor

Methods

Staticaverage

  • average<T extends object>(
        source: HashArray<T>,
        key: Key,
        index: Key,
        weightKey?: Key,
    ): number

  • Iterates deeply over items specified by key and index with an optional weightKey and calculates the average value.

    Type Parameters

    • T extends object

    Parameters

    • source: HashArray<T>

      Source HashArray.

    • key: Key

      The Key to retrieve item(s) to iterate.

    • index: Key

      A specific Key in each item to lookup.

    • OptionalweightKey: Key

      A specific Key in each item to provide a weighting value.

    Returns number

    The average value for the given iteration.

Staticdifference

  • difference<T extends object>(
        source: HashArray<T>,
        target: HashArray<T>,
        output?: HashArray<T>,
    ): HashArray<T>

  • Returns the difference of this HashArray and a target HashArray. If no output HashArray is provided the source is cloned.

    Type Parameters

    • T extends object

    Parameters

    Returns HashArray<T>

    Returns a new HashArray that contains the difference between source (A) and target (B) HashArrays. Returns A - B.

Staticsample

Staticsum

  • sum<T extends object>(
        source: HashArray<T>,
        key: Key,
        index: Key,
        weightKey?: Key,
    ): number

  • Iterates deeply over items specified by key and index with an optional weightKey and calculates the sum.

    Type Parameters

    • T extends object

    Parameters

    • source: HashArray<T>

      Source HashArray.

    • key: Key

      The Key to retrieve item(s) to iterate.

    • index: Key

      A specific Key in each item to lookup.

    • OptionalweightKey: Key

      A specific Key in each item to provide a weighting value.

    Returns number

    The sum for the given iteration.

Settings

Member Visibility

On This Page

Constructors
Methods