Skip to content

RitterGustave-TR/Simple-Dsa

Repository files navigation

Publish Package

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Simple Data Structures & Algorithms

Simple, Extendable, Data Structures + Algorithms
Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot This project was born out of the need to have very small base line data structures with the intent to extend them in the projects they're imported in, or you could simply just use the baseline structures. Making these data structures very generic to cover a wide range of use is important for this project.

(back to top)

Built With

  • [Typescript]

(back to top)

Getting Started

As with any other npm package, npm install.

Prerequisites / Installation

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm i @ritterg/simple-dsa

(back to top)

Usage

You will be able to import data structures straight from the package based on category.

 import {
     // Lists
     LinkedList,
     SingleLinkedList,
     SinglyLinkedList, 
     DoubleLinkedList,
     DoublyLinkedList,
     // Trees & Heaps
     Graph,
     BinarySearchTree,
     BSTNode,
     HeapDataNode,
     BinaryHeap,
     // Queues
     Queue,
     PriorityQueue,
     // Stack
     Stack,
 } from "@ritterg/simple-dsa";

Then just instantiate a new DS via the new keyword

```js
    const list = new LinkedList();
```

... more documentation for DS Signatures coming soon

(back to top)

Roadmap

  • Graph

    • Weighted
    • Unweighted
    • Directed
    • Undirected
  • Heap

  • Tree

    • Binary Search
    • Red Black
    • AVL
  • Lists

    • Linked Single
    • Linked Double
  • Queue

    • Priority Queue
  • Stack

  • Hash Tables

  • Algorithms

    • Djikstras
    • Revolving Calculated Window

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Feel free to contribute!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/rgustave07/simple-dsa

(back to top)

Acknowledgments

(back to top)

About

Simple algorithm and data structure implementations in TS!

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors