https://github.com/aaronjsutton/easyroot

Swift framework to simplify radicals.
https://github.com/aaronjsutton/easyroot

Last synced: 3 days ago
JSON representation

Swift framework to simplify radicals.

• Host: GitHub
• URL: https://github.com/aaronjsutton/easyroot
• Owner: aaronjsutton
• License: apache-2.0
• Created: 2018-01-23T00:13:42.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-29T17:44:47.000Z (almost 7 years ago)
• Last Synced: 2025-01-07T23:42:00.802Z (6 days ago)
• Language: Swift
• Homepage: https://aaronjsutton.github.io/EasyRoot/
• Size: 282 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Logo](https://aaronjsutton.github.io/EasyRoot/img/logo.png)

A Swift framework for simplifying radicals.

[![Build Status](https://travis-ci.org/aaronjsutton/EasyRoot.svg?branch=master)](https://travis-ci.org/aaronjsutton/EasyRoot)

## Usage

### [CocoaPods](http://cocoapods.org)

Add EasyRoot to your Podfile:

```ruby

pod 'EasyRoot'

```

And run `pod install`

## Example

To use the `Radical` object:

```swift

// 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](https://aaronjsutton.github.io/EasyRoot/)

## 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](https://github.com/realm/jazzy)