diverse-data-structures
v1.2.0
Published
Diverse data structures.
Downloads
8
Readme
Diverse Data Structures v1.2.0 Documentation
Table of contents
Description
Provides diverse data structures implementations.
Installation
For the usage in CJS or ESM run the following command:
npm i diverse-data-structuresFor script tag usage include the following script:
<!DOCTYPE html>
<html>
<body>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/diverse-data-structures.min.js"></script>
</body>
</html>Usage example
ESM:
import { Stack } from 'diverse-data-structures'
const stack = new Stack(10, Int8Array)
stack.push(45)
stack.push(44)
stack.push(100)
stack.pop()Classic:
const { Stack } = window.diverseDataStructures
const stack = new Stack(10, Int8Array)
stack.push(45)
stack.push(44)
stack.push(100)
stack.pop()API
class Stack
- Models
ArrayType<T>type ArrayType<T> = | (new (args: any) => Array<T>) | (new (args: any) => Int8Array) | (new (args: any) => Int16Array) | (new (args: any) => Int32Array) | (new (args: any) => Uint8Array) | (new (args: any) => Uint16Array) | (new (args: any) => Uint32Array) | (new (args: any) => Float32Array) | (new (args: any) => Float64Array) | (new (args: any) => BigInt64Array) | (new (args: any) => BigUint64Array)
- Constructor parameters
- maxSize
numberstack size - array
Arraycontainer where the stack will store its items. It supports typed arrays for the memory usage optimization Default:new Array(maxSize)
- maxSize
- Properties
- maxSize
numberstack size - items
ArrayType<T>container where the stack will store its items - top
numberis used to access the element at the top
- maxSize
- Methods
- push(item)
- item
anystack item - Returns:
boolean - Description: if stack is overflowed, it will return
false, else it will returntrue
- item
- pop()
- Returns:
boolean - Description: if stack is underflowed, it will return
false, else it will return the stack item
- Returns:
- push(item)
class ExtendedStack
- Models
ArrayType<T>type ArrayType<T> = | (new (args: any) => Array<T>) | (new (args: any) => Int8Array) | (new (args: any) => Int16Array) | (new (args: any) => Int32Array) | (new (args: any) => Uint8Array) | (new (args: any) => Uint16Array) | (new (args: any) => Uint32Array) | (new (args: any) => Float32Array) | (new (args: any) => Float64Array) | (new (args: any) => BigInt64Array) | (new (args: any) => BigUint64Array)
- Constructor parameters
- maxSize
numberstack size - array
Arraycontainer where the stack will store its items. It supports typed arrays for the memory usage optimization Default:new Array(maxSize)
- maxSize
- Properties
- maxSize
numberstack size - items
ArrayType<T>container where the stack will store its items - top
numberis used to access the element at the top
- maxSize
- Methods
- peek()
- Returns:
any - Description: Returns most recently added item from the stack, without removing it from the stack
- Returns:
- duplicate()
- Returns:
boolean - Description: Picks top item and pushes its duplicate at the top of the stack
- Returns:
- swap()
- Returns:
boolean - Description: Swaps the places of two upper items
- Returns:
- peek()