stackedmate

Stacked Mate - A Data Structures Library

Stacked Mate is a lightweight and easy-to-use data structures library that provides several commonly used data structures for use in your projects.

Installation

npm install stackedmate

Data Structures

• Linked List - a data structure that consists of a sequence of nodes, each containing a reference to the next node in the sequence.
• Queue - First-In-First-Out (FIFO) structure that allows you to store and retrieve elements in a specific order.
• Stack - Last-In-First-Out (LIFO) structure that allows you to store and retrieve elements in a specific order.
• BinartHeap - a data structure that allows you to store elements in a specific order. The order is determined by the priority of the elements.

Features

Singly Linked List And Doubly Linked List

• push - adds a node to the end of the list
• pop - removes a node from the end of the list
• shift - removes a node from the beginning of the list
• unshift - adds a node to the beginning of the list
• get - returns the node at the specified index
• set - sets the value of the node at the specified index
• insert - inserts a node at the specified index
• remove - removes a node at the specified index
• reverse - reverses the list
• slice - returns a new list containing the nodes between the specified indices
• concat - combines two lists into one list
• toArray - returns an array containing the values of the nodes in the list
• toString - returns a string containing the values of the nodes in the list
• length - returns the number of nodes in the list
• head - returns the first node in the list
• tail - returns the last node in the list

Example

import { SinglyLinkedList } from "stack-mate";

const list = new SinglyLinkedList();

list.push(1);
list.push(2);
list.push(3);

list.pop(); // 3

list.set(1, 4);

list.get(1); // 4

list.insert(1, 5);

list.remove(1); // 5

Queue

• enqueue - adds an element to the end of the queue
• dequeue - removes an element from the beginning of the queue
• peek - returns the element at the beginning of the queue
• length - returns the number of elements in the queue
• isEmpty - returns true if the queue is empty, false otherwise
• clear - removes all elements from the queue
• toArray - returns an array containing the elements in the queue
• toString - returns a string containing the elements in the queue

Example

import { Queue } from "stack-mate";

const queue = new Queue();

queue.enqueue(1);
queue.enqueue(2);
queue.enqueue(3);

queue.dequeue(); // 1
queue.dequeue(); // 2
queue.dequeue(); // 3

Stack

• add - adds an element to the top of the stack
• remove - removes an element from the top of the stack
• peek - returns the element at the top of the stack
• length - returns the number of elements in the stack
• isEmpty - returns true if the stack is empty, false otherwise
• clear - removes all elements from the stack
• toArray - returns an array containing the elements in the stack
• toString - returns a string containing the elements in the stack

Example

import { Stack } from "stack-mate";

const stack = new Stack();

stack.add(1);
stack.add(2);
stack.add(3);

stack.remove(); // 3
stack.remove(); // 2
stack.remove(); // 1

Binary Heap

• add - adds an element to the heap
• remove - removes an element from the heap
• peek - returns the element at the top of the heap
• size - returns the number of elements in the heap
• isEmpty - returns true if the heap is empty, false otherwise
• clear - removes all elements from the heap
• merge - merges two heaps into one heap

Example

import { BinaryHeap } from "stack-mate";

const heap = new BinaryHeap(
  [7, 2, 4],
  (node) => node,
  (a, b) => a - b
);

heap.add(1);
heap.add(3);
heap.add(5);

heap.remove(); // 1
heap.remove(); // 2
heap.remove(); // 3
heap.remove(); // 4
heap.remove(); // 5
heap.remove(); // 7