https://github.com/gleam-community/maths

A basic mathematics library containing fundamental functions and utilities.
https://github.com/gleam-community/maths

gleam gleam-community gleam-lang mathematics maths

Last synced: 27 days ago
JSON representation

A basic mathematics library containing fundamental functions and utilities.

• Host: GitHub
• URL: https://github.com/gleam-community/maths
• Owner: gleam-community
• License: apache-2.0
• Created: 2022-12-21T18:27:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T21:17:39.000Z (8 months ago)
• Last Synced: 2024-04-11T00:43:36.605Z (8 months ago)
• Topics: gleam, gleam-community, gleam-lang, mathematics, maths
• Language: Gleam
• Homepage:
• Size: 171 KB
• Stars: 17
• Watchers: 4
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-gleam - gleam_community_maths - [📚](https://hexdocs.pm/gleam_community_maths/) - A basic maths library (Packages / Numbers)

README

        
# gleam-community/maths

[![Package Version](https://img.shields.io/hexpm/v/gleam_community_maths)](https://hex.pm/packages/gleam_community_maths)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleam_community_maths/)

A basic mathematics library that contains some of the most fundamental mathematics functions and utilities.

The library supports both targets: Erlang and JavaScript.

## Quickstart

```gleam

import gleam/float

import gleam/iterator

import gleam/option.{Some}

import gleam_community/maths/arithmetics

import gleam_community/maths/combinatorics.{WithoutRepetitions}

import gleam_community/maths/elementary

import gleam_community/maths/piecewise

import gleam_community/maths/predicates

import gleeunit/should

pub fn example() {

  // Evaluate the sine function

  let result = elementary.sin(elementary.pi())

  // Set the relative and absolute tolerance

  let assert Ok(absolute_tol) = elementary.power(10.0, -6.0)

  let relative_tol = 0.0

  // Check that the value is very close to 0.0

  // That is, if 'result' is within +/- 10^(-6)

  predicates.is_close(result, 0.0, relative_tol, absolute_tol)

  |> should.be_true()

  // Find the greatest common divisor

  arithmetics.gcd(54, 24)

  |> should.equal(6)

  // Find the minimum and maximum of a list

  piecewise.extrema([10.0, 3.0, 50.0, 20.0, 3.0], float.compare)

  |> should.equal(Ok(#(3.0, 50.0)))

  // Determine if a number is fractional

  predicates.is_fractional(0.3333)

  |> should.equal(True)

  // Generate all k = 2 combinations of [1, 2, 3]

  let assert Ok(combinations) =

    combinatorics.list_combination([1, 2, 3], 2, Some(WithoutRepetitions))

  combinations

  |> iterator.to_list()

  |> should.equal([[1, 2], [1, 3], [2, 3]])

}

```

## Installation

`gleam_community` packages are published to [hex.pm](https://hex.pm/packages/gleam_community_maths)

with the prefix `gleam_community_`. You can add them to your Gleam projects directly:

```sh

gleam add gleam_community_maths

```