Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.29 KB

README.md

File metadata and controls

60 lines (38 loc) · 1.29 KB

Logo

A Swift framework for simplifying radicals.

Build Status

Usage

Add EasyRoot to your Podfile:

pod 'EasyRoot'

And run pod install

Example

To use the Radical object:

// Simplify the square root of 27
// Create the radical object
let expression = Radical(root: 27)
// Simplify the expression
expression.simplify()
// Print the result
print("\(expression.coefficient) roots of \(expression.radicand)")
// => 3 roots of 3

Currently, the expression will remain the same if the simplified result contains an imaginary number.

For more examples, see the documentation

Features

Currently supports simplifying integer-only radicals. For example:

  • Root 4
    • Result: 2
  • 3 root -27
    • Result: -3

And so forth.

Contributing

Bugs

Feel free to open issues for any bugs found.

Pull Requests

If you wish to contribute to EasyRoot, create a new branch, implement your feature or fix, and then submit a pull request.

Documentation

Generate documentation with Jazzy