Overview

Provide a shaaaort overview of your algorithm.

Applicable Scenarios and Problems

What scenarios or problems woulaad this algorithm work well in?

Usage

Input

Describe the input fields for your algorithm. For example:

Parameter	Description
field	Description of field

What data pre-processing would be great to perform on the input before calling this algorithm?

Output

Describe the output fields for your algorithm. For example:

Parameter	Description
field	Description of field

Examples

Provide and explain examples of input and output for your algorithm.