Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lfex/horatio

The rational and most trusted friend of the tragic hero, Floating Point
https://github.com/lfex/horatio

Last synced: 1 day ago
JSON representation

The rational and most trusted friend of the tragic hero, Floating Point

Host: GitHub
URL: https://github.com/lfex/horatio
Owner: lfex
License: other
Created: 2015-08-22T14:35:43.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2016-11-20T10:27:05.000Z (almost 8 years ago)
Last Synced: 2024-10-30T16:55:52.765Z (9 days ago)
Language: Erlang
Size: 54.7 KB
Stars: 2
Watchers: 5
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # horatio

[![Build Status][travis badge]][travis] [![LFE Versions][lfe badge]][lfe] [![Erlang Versions][erlang badge]][versions] [![Tags][github tags badge]][github tags] [![Downloads][hex downloads]][hex package]

[![Horatio logo][logo]][logo]

*The rational and most trusted friend of the tragic hero, Floating Point*

## Table of Contents

* [Introduction](#introduction-)

* [Installation](#installation-)

* [Usage](#usage-)

  * [Creating Fractions](#creating-fractions-)

  * [Convenience Functions](#convenience-functions-)

    * [Printing](#printing-fractions-)

    * [Converting](#converting-)

  * [Math](#math-)

    * [Arithmatic](#arithmatic-)

    * [Operations](#operations-)

    * [Powers](#powers-)

* [API](#api-)

* [License](#license-)

## Introduction [↟](#table-of-contents)

Add content to me here!

## Installation [↟](#table-of-contents)

Just add it to your ``rebar.config`` deps:

```erlang

{deps, [

  ...

  {horatio, ".*",

    {git, "[email protected]:lfex/horatio.git", "master"}}

    ]}.

```

And then do the usual:

```bash

$ rebar get-deps

$ rebar compile

```

## Usage [↟](#table-of-contents)

### Creating Fractions [↟](#table-of-contents)

You may create frations using any one of the following:

```lfe

> (ratio:new 2 3)

#(ratio 2 3)

> (ratio:new "2/3")

#(ratio 2 3)

> (ratio:new '2/3)

#(ratio 2 3)

> (ratio:new #(2 3))

#(ratio 2 3)

```

### Convenience Functions [↟](#table-of-contents)

#### Printing Fractions [↟](#table-of-contents)

```lfe

> (set r (ratio:new 2 3))

#(ratio 2 3)

> (ratio:print r)

2/3

ok

```

You can also use the alias ``pp`` (for "pretty print"):

```lfe

> (ratio:pp r)

2/3

ok

```

#### Converting [↟](#table-of-contents)

To strings, atoms, and floats:

```lfe

> (ratio:->str r)

"2/3"

> (ratio:->atom r)

2/3

> (ratio:->float r)

0.6666666666666666

```

Floats to rational numbers:

```lfe

> (ratio:float->ratio 0.5)

#(ratio 1 2)

> (ratio:float->ratio 1.5)

#(ratio 3 2)

> (ratio:float->ratio 3.1415)

#(ratio 6283 2000)

```

### Math [↟](#table-of-contents)

For the following examples we'll use these rational numbers:

```lfe

> (set r1 (ratio:new '1/3))

#(ratio 1 3)

> (set r2 (ratio:new '1/4))

#(ratio 1 4)

```

#### Arithmatic [↟](#table-of-contents)

Addition:

```lfe

> (ratio:pp (ratio:add r1 r2))

7/12

ok

```

Subtraction:

```lfe

> (ratio:pp (ratio:sub r1 r2))

1/12

ok

```

Multiplication:

```lfe

> (ratio:pp (ratio:mult r1 r2))

1/12

ok

```

Division:

```lfe

> (ratio:pp (ratio:div r1 r2))

4/3

ok

```

#### Operations [↟](#table-of-contents)

```lfe

> (ratio:eq r1 r2)

false

> (ratio:eq r2 r2)

true

```

#### Powers [↟](#table-of-contents)

```lfe

> (ratio:pp (ratio:pow r1 4))

1/81

ok

> (ratio:pp (ratio:pow r1 -4))

81/1

ok

> (ratio:pp (ratio:pow r2 4))

1/256

ok

> (ratio:pp (ratio:pow r2 -4))

256/1

ok

```

Large numbers:

```lfe

> (ratio:pp (ratio:div (ratio:pow 3 200) (ratio:pow 2 430)))

8960496791105607/93536104789177786765035829293842113257979682750464

ok

```

## API [↟](#table-of-contents)

The list of functions currently supported by the ratio library are as

follows:

```lfe

ratio:->atom/1

ratio:->float/1

ratio:->str/1

ratio:add/2

ratio:denom/1

ratio:div/2

ratio:eq/2

ratio:float->ratio/1

ratio:gcd/2

ratio:mult/2

ratio:new/1

ratio:new/2

ratio:normalize/1

ratio:normalize/2

ratio:numer/1

ratio:pow/2

ratio:pp/1

ratio:print/1

ratio:ratio/1

ratio:ratio/2

ratio:sub/2

```

## License [↟](#table-of-contents)

Apache Version 2 License

Copyright © 2015-2016, Duncan McGreggor 

[logo]: priv/images/horatio.jpg

[org]: https://github.com/lfex

[github]: https://github.com/lfex/horatio

[gitlab]: https://gitlab.com/lfex/horatio

[travis]: https://travis-ci.org/lfex/horatio

[travis badge]: https://img.shields.io/travis/lfex/horatio.svg

[lfe]: https://github.com/rvirding/lfe

[lfe badge]: https://img.shields.io/badge/lfe-1.2.0-blue.svg

[erlang badge]: https://img.shields.io/badge/erlang-R16%20to%2019.1-blue.svg

[versions]: https://github.com/lfex/horatio/blob/master/.travis.yml

[github tags]: https://github.com/lfex/horatio/tags

[github tags badge]: https://img.shields.io/github/tag/lfex/horatio.svg

[github downloads]: https://img.shields.io/github/downloads/lfex/horatio/total.svg

[hex badge]: https://img.shields.io/hexpm/v/horatio.svg?maxAge=2592000

[hex package]: https://hex.pm/packages/horatio

[hex downloads]: https://img.shields.io/hexpm/dt/horatio.svg