===================================
vedicpy documentation
===================================

.. image:: /images/logo.png
    :alt: Logo
    
**A Python Package for Vedic Mathematics**

.. image:: https://img.shields.io/pypi/v/vedicpy.svg
   :target: https://pypi.python.org/pypi/vedicpy
   :alt: PyPI
.. image:: https://img.shields.io/pypi/pyversions/vedicpy.svg
   :target: https://pypi.python.org/pypi/vedicpy
   :alt: Python Version
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg
   :target: https://github.com/utkarsh0702/vedicpy/blob/master/LICENSE
   :alt: License

For humans, through regular mathematical steps, solving problems sometimes are complex and time-consuming. But using Vedic Mathematic’s General Techniques (applicable to all sets of given data) and Specific Techniques (applicable to specific sets of given data), numerical calculations can be done very fast.

This package is a python implementation of Vedic mathematical sutras. It uses the Vedic mathematics for performing basic mathematical operations like multiplication, division, square roots, cube roots etc.

Since Vedic maths sutras work on individual digits in a number as opposed to the whole number, the implementation works slower on small digit numbers but works faster on larger digit numbers and some other operations like finding the square root or the cube root of a number.


.. toctree::
   :caption: Getting started
   :maxdepth: 1
   
   installation
   tutorial
   troubleshooting


.. toctree::
   :caption: Functional Documentation
   :maxdepth: 1
   
   /functions/compliment.rst
   /functions/cube.rst
   /functions/cuberoot.rst
   /functions/divisibility.rst
   /functions/division.rst
   /functions/multiply.rst
   /functions/recurring.rst
   /functions/square.rst
   /functions/squareroot.rst


.. toctree::
   :caption: Others
   :maxdepth: 1
   
   license_help
   CONTRIBUTING
   Credits

