semvec/pypi-packages huggingface dataset:
data-structures-py-jordankbm 0.1.0
Implementation of various data structures in Python from scratch
License: MIT

# data-structures-python


### Data structures

In this library, we implemented some important data structures and seen how they work. We have:

* **`Array_new`:** This was our custom implementation of an array. It provided a way to store a contiguous sequence of elements and likely included basic array operations like initialization and element access. We used it as one of the underlying structures for our `Stack` implementation.

* **`Node`:** This class served as the fundamental building block for our linked list and tree implementations. Each `Node` object held a `value` and references (`next` and optionally `prev` for doubly linked lists, `left` and `right` for trees) to other nodes in the data structure.

* **`LinkedList`:** This class implemented the linked list data structure, utilizing `Node` objects. It supported both singly and doubly linked lists and provided methods for inserting, deleting, accessing, searching, reversing, and updating elements within the list. We used it as the underlying structure for our `Stack` and `Queue` implementations.

* **`Stack`:** This class implemented the stack data structure, which follows the LIFO principle. It could be initialized with either an `Array_new` or a `LinkedList` object as its underlying storage. It provided methods for `push` (to add elements to the top), `pop_stack` (to remove and return the top element), `peek` (to view the top element), `isEmpty` (to check if the stack is empty), and `display_stack` (to show the stack's contents).

* **`Queue`:** This class implemented the queue data structure, following the FIFO principle. It used a `LinkedList` as its underlying storage. It provided methods for `enqueue` (to add elements to the rear), `dequeue` (to remove and return the front element), `peek` (to view the front element), `rear` (to view the rear element), `isNull` (to check if the queue is empty), and `display_queue` (to show the queue's contents).

* **`BinaryTree`:** This class inherited from the `Node` class and represented a binary tree. Each instance was a node that could have a left and a right child. It included methods for different tree traversals (`pre_order`, `in_order`, `post_order`), searching for nodes (`search_node`, `search_BST` for Binary Search Trees), and adding nodes while maintaining the BST property (`addnode`). It also had methods for building and drawing a graph representation of the tree using `networkx` and `matplotlib` (`build_graph`, `draw_graph`).

In essence, these classes provide the blueprints and functionalities for creating and manipulating different types of data structures, each designed for specific ways of organizing and accessing data.
docfly 3.0.0
A utility tool to help you build better sphinx documents.
License: MIT
Requires Python: <4.0,>=3.9


.. image:: https://readthedocs.org/projects/docfly/badge/?version=latest
    :target: https://docfly.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/docfly-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/docfly-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/docfly-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/docfly-project

.. image:: https://img.shields.io/pypi/v/docfly.svg
    :target: https://pypi.python.org/pypi/docfly

.. image:: https://img.shields.io/pypi/l/docfly.svg
    :target: https://pypi.python.org/pypi/docfly

.. image:: https://img.shields.io/pypi/pyversions/docfly.svg
    :target: https://pypi.python.org/pypi/docfly

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/docfly-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/docfly-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://docfly.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/docfly-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/docfly-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/docfly-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/docfly#files


Welcome to ``docfly`` Documentation
==============================================================================
.. image:: https://docfly.readthedocs.io/en/latest/_static/docfly-logo.png
    :target: https://docfly.readthedocs.io/en/latest/

``docfly`` is a utility tool that simplifies `Sphinx documentation <http://www.sphinx-doc.org/en/stable/index.html>`_ creation by automating repetitive tasks.

**Key Features**

- **Automatic API Reference Generation**: Creates comprehensive .rst files for your entire package structure
- **Automatic Table of Contents**: Generates and maintains toctree directives that stay in sync with your folder structure
- **Multi-Language Support**: Simplifies creating documentation in multiple languages
- **Jupyter Notebook Integration**: Seamlessly incorporates Jupyter notebooks into your documentation


.. _install:

Install
------------------------------------------------------------------------------

``docfly`` is released on PyPI, so all you need is:

.. code-block:: console

    $ pip install docfly

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade docfly