Class Numbers

A collection of number Queue with the following efficient mathematic computation:

  • minimum value in the collection
  • maximum value in the collection
  • average value of the collection

Hierarchy

Constructors

constructor

Properties

_average? _max _min _sum

Accessors

average back capacity front maximum minimum size

Methods

[iterator] clear pop push

Constructors

constructor

  • Instantiate the collection of the number

    Parameters

    • Optional capacity: number

      if set it limits the number of values stored, any exceding number pops the first number pushed (FIFO)

    Returns Numbers

Properties

Private Optional _average

_average?: any

Private _max

_max: any

Private _min

_min: any

Private _sum

_sum: any

Accessors

average

  • get average(): number

  • average value of the collection, or 0 if collection if empty

    Returns number

back

  • get back(): Type

  • The back element

    Returns Type

capacity

  • get capacity(): undefined | number

  • Maximum capacity for the queue, if not set queue has unlimited capacity

    Returns undefined | number

  • set capacity(value): void

  • Set a maximum capacity for the queue, if you push new value exceding this capacity the firsts are removed (FIFO) if set to undefined the queue is unlimited

    Parameters

    • value: undefined | number

    Returns void

front

  • get front(): Type

  • The front element

    Returns Type

maximum

  • get maximum(): number

  • maximum value in the collection, or 0 if colleciton is empty

    Returns number

minimum

  • get minimum(): number

  • minimum value in the collection, or 0 if colleciton is empty

    Returns number

size

  • get size(): number

  • Number of element in the queue

    Returns number

Methods

[iterator]

  • [iterator](): IterableIterator<number>

  • Iterator though queue's elements

    Returns IterableIterator<number>

clear

  • Clear all the numbers, collection becomes empty

    Returns Numbers

    this

pop

  • Pop the front number from the collection

    Returns undefined | number

    the front number removed

push

  • Push a value to the back to the collection

    Parameters

    • value: number

      number to add

    Returns Numbers

    this

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc