math-for-cannibals 1.12

Math functions to simplify mathematical tasks

Math for cannibals

This is a python package with mathematical functions used to automate mathematical tasks

Table of Contents

1. Installation
2. Practical Information
3. Usage
4. Contributing
5. License

Installation

pip install math-for-cannibals

Practical Information

When using the class, you will be promted with a, b and c values.
I have chosen to define these values like so:

Usage

Table of Contents

1. Configuring class
2. Using the class
3. Getting the values

Configuring class

The class used to calculations will be configured like this:

from program.RightTriangle import RightTriangle

RightTriangle = RightTriangle(aSide, bSide, cSide, aDegree, bDegree)

An example of this can look like:

Rt = RightTriangle(aDegree=20)

Using the class

You use the class by entering the information you have about the triangle.

Some examples using the class:

Rt = RightTriangle(aDegree=20)

Rt = RightTriangle(aSide=2, bSide=3)

Rt = RightTriangle(aDegree=20, aSide=2)

Getting the values

In order to get the calculated angles and sides of the triangle you need to access the properties of the class.

Rt = RightTriangle(aDegree=20)
Rt.get_degrees()

There are three properties:
get_degrees() (which only returns the degrees of the triangle)
get_sides() (which only returns the sides of the triangle)
get_triangle() (which returns the sides and degrees of the triangle)

Contributing

Contributing is welcome, please just email so I can get a clear understanding of the improvement. Please make sure to update tests as appropriate.

License

MIT