Skip to main content

A python package designed to facilitate the solving and manipulation of quadratic equations.

Project description

Pyquadratic

Python build & test

Description

A python package designed to facilitate the solving and manipulation of quadratic equations.

simplifyQuadratic()

Returns a simplified quadratic functions from the given input quadratic function.

Parameters

Parameter Type Values
stdForm str "2x^2+8x+2"

Return type

str

Errors

  • If the stdForm value provided is not in the correct format a, Value Error exception is raised.

realSolution()

Returns the solutions for a quadratic equation entered in the format ax^2+bx+c

Parameters

Parameter Type Values
stdForm str "2x^2+8x+2"

Return type

float[2] or int[2]

Errors

  • If the stdForm value provided is not in the correct format, a Value Error exception is raised.
  • If a real solution does not exist, a Value Error exception is raised.

toFactoredForm()

Returns the factored form of the corresponding standard form of quadratic equation

Parameters

Parameter Type Values
stdForm str "2x^2+8x+2"

Return type

str

Errors

  • If the stdForm value provided is not in the correct format, a Value Error exception is raised.
  • If a real solution does not exist, a Value Error exception is raised.

toVertexForm()

Returns the vertex form of the corresponding standard form of quadratic equation

Parameters

Parameter Type Values
stdForm str "2x^2+8x+2"

Return type

str

Errors

  • If the stdForm value provided is not in the correct format, a Value Error exception is raised.

pyquadratic._readString() (Private: for contributors only)

Returns the coefficients for an ax^2+bx+c string of a quadratic equation

Parameters

Parameter Type Values
stdForm str "2x^2+8x+2"

Return type

float[3] or int[3]

Errors

  • If the stdForm value provided is not in the correct format, a Value Error exception is raised.

Instructions

Use the standard form ax^2+bx+c to use pyquadratic functions (Always assume = 0)

How to import:

Go to terminal and run: pip install pyquadratic

In your python file, be sure to include:

from pyquadratic.pyquadratic import *

Now you will be able to use the functions included in the pyquadratic package!

Example Code

How to Contribute to the Project:

How to Set Up the Virtual Environment

  • Fork the Repository.

  • Clone it to your local directory.

  • Go to terminal, locate the project directory, and run: pip install pipenv.

  • Run pipenv shell to activate the virtual environment.

  • Run pipenv install to install all the required dependencies for developemnt.

How to Build

  • Before every build, make sure you delete dist and pyquadratic.egg-info directory.

  • Update version number in pyproject.toml if approved.

  • Go to terminal, locate the project directory, and run: python -m build or python3 -m build.

How to Test

  • Go to terminal, locate the project directory, and run: pytest.

Team Members

Nicolas Izurieta: https://github.com/ni2050

Patrick Zhao: https://github.com/PatrickZhao0

Brad Yin: https://github.com/BREADLuVER

Yucheng Xu: https://github.com/Yucheng-XPH

Link to Package

https://pypi.org/project/pyquadratic/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyquadratic-1.0.4.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyquadratic-1.0.4-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

Details for the file pyquadratic-1.0.4.tar.gz.

File metadata

  • Download URL: pyquadratic-1.0.4.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pyquadratic-1.0.4.tar.gz
Algorithm Hash digest
SHA256 c7dd3852bb33f5a756722ce824f76c62969185b7a66976d37021053413fbea84
MD5 64291f771cf3029777d7b5b9d83e8b0f
BLAKE2b-256 8725523cc6da9dc71303327e22bfff56a7823e9a8426b8c05bb07427a5fefa42

See more details on using hashes here.

File details

Details for the file pyquadratic-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: pyquadratic-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 31.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pyquadratic-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 894a802eb9949eb547ac5194bac8798725d916a63ab6fc8706c07a546ca74d91
MD5 08fc8bd5106c1a64fbd05c25db16b4aa
BLAKE2b-256 f0ad48127ef7f4136cd9a518762e39b489bea77ae2be402cf1cbf4525a1a2b89

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page