Merge branch 'master' of https://github.com/Omar-Belghaouti/PythonComplex

Author: omdxp

.gitignore

@@ -0,0 +1,104 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

README.md

@@ -5,3 +5,96 @@ Complex class for different operations on complex numbers.
 - This class is essentially for mathematical operations on complex numbers.
 - It is very easy and intuitif to use, as any mathematicain would expect.
 - There is more to come on this class, like power of complex numbers.
+
+## Installation
+
+Use the package manager [pip](https://pypi.org/project/cmpx/) to install cmpx.
+
+```bash
+pip install cmpx
+```
+
+## Usage
+### Importing Complex class
+```python
+from cmpx.Complex import Complex
+```
+### Different instanciations of Complex class
+```python
+# Instanciation 1
+number = Complex() # --> Real = 0, Imaginary = 0
+print(number)
+# Instanctiation 2
+number = Complex(42) # --> Real = 42, Imaginary = 0
+print(number)
+# Instanciation 3
+number = Complex(12, -3.2) # --> Real = 12, Imaginary = -3.2
+print(number)
+# Instanciation 4
+number = Complex(im=13.2, re=5) # --> Real = 5, Imaginary = 13.2
+print(number)
+# Instanciation 5
+number = Complex(re=3, im=-2.4, restore=False) # restore argument is by default True, whenever an error occurs on operation, the last result will be restored to the object, else if it is False then the object will be simply None.
+```
+### Basic operations
+```python
+num1 = Complex(re=3, im=-2.5)
+num2 = Complex(re=4.2, im=13.2)
+# Summation
+print('({}) + ({}) = {}'.format(num1, num2, num1 + num2))
+# Substraction
+print('({}) - ({}) = {}'.format(num1, num2, num1 - num2))
+# Multiplication
+print('({}) * ({}) = {}'.format(num1, num2, num1 * num2))
+# Division
+print('({}) / ({}) = {}'.format(num1, num2, num1 / num2))
+# Floor division
+print('({}) // ({}) = {}'.format(num1, num2, num1 // num2))
+## Affecting the result directly on the number
+# Summation
+print('({}) += ({})'.format(num1, 2), end=' --> ')
+num1 += 2
+print(num1)
+# Substraction
+print('({}) -= ({})'.format(num1, num2), end=' --> ')
+num1 -= num2
+print(num1)
+# Multiplication
+print('({}) *= ({})'.format(num1, 2), end=' --> ')
+num1 *= 2
+print(num1)
+# Division
+print('({}) /= ({})'.format(num1, num2), end=' --> ')
+num1 /= num2
+print(num1)
+# Floor division
+print('({}) //= ({})'.format(num1, 2), end=' --> ')
+num1 /= 2
+print(num1)
+# Congugated of a complex number
+print('con({}) = {}'.format(num2, num2.con()))
+# Module of a complex number
+print('mod({}) = {}'.format(num2, num2.mod()))
+```
+### Comparisons of Complex numbers
+```python
+num1 = Complex(im=3.1, re=-5)
+num2 = Complex(im=-1.5, re=0.6)
+# Greater than
+if(num1 > num2): print('({}) > ({})'.format(num1, num2))
+# Greater or equal
+if(num1 >= num2): print('({}) >= ({})'.format(num1, num2))
+# Less than
+if(num1 < num2): print('({}) < ({})'.format(num1, num2))
+# Less or equal
+if(num1 <= num2): print('({}) <= ({})'.format(num1, num2))
+# Equal
+if(num1 == num2): print('({}) == ({})'.format(num1, num2))
+# Not equal
+if(num1 != num2): print('({}) != ({})'.format(num1, num2))
+```
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.