aboutsummaryrefslogtreecommitdiff
path: root/aoc2023/build/packages/gleam_community_maths/README.md
diff options
context:
space:
mode:
authorH.J <thechairman@thechairman.info>2024-10-09 11:35:09 -0400
committerH.J <thechairman@thechairman.info>2024-10-09 11:35:09 -0400
commit6156a9ef7be4012063a042aafb4e9b0d7eadde8e (patch)
tree5d990ded3baba51ca3934b51994285f7d5915c34 /aoc2023/build/packages/gleam_community_maths/README.md
parentef2ad0ee020b6754c230ae08f5979948b8db1350 (diff)
downloadgleam_aoc-6156a9ef7be4012063a042aafb4e9b0d7eadde8e.tar.gz
gleam_aoc-6156a9ef7be4012063a042aafb4e9b0d7eadde8e.zip
cleanup
Diffstat (limited to 'aoc2023/build/packages/gleam_community_maths/README.md')
-rw-r--r--aoc2023/build/packages/gleam_community_maths/README.md59
1 files changed, 0 insertions, 59 deletions
diff --git a/aoc2023/build/packages/gleam_community_maths/README.md b/aoc2023/build/packages/gleam_community_maths/README.md
deleted file mode 100644
index c912757..0000000
--- a/aoc2023/build/packages/gleam_community_maths/README.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# 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_community/maths/arithmetics
-import gleam_community/maths/combinatorics
-import gleam_community/maths/elementary
-import gleam_community/maths/piecewise
-import gleam_community/maths/predicates
-import gleam/float
-
-pub fn main() {
- // Evaluate the sine function
- elementary.sin(elementary.pi())
- // Returns Float: 0.0
-
- // Find the greatest common divisor
- arithmetics.gcd(54, 24)
- // Returns Int: 6
-
- // Find the minimum and maximum of a list
- piecewise.extrema([10.0, 3.0, 50.0, 20.0, 3.0], float.compare)
- // Returns Tuple: Ok(#(3.0, 50.0))
-
- // Find the list indices of the smallest value
- piecewise.arg_minimum([10, 3, 50, 20, 3], float.compare)
- // Returns List: Ok([1, 4])
-
- // Determine if a number is fractional
- predicates.is_fractional(0.3333)
- // Returns Bool: True
-
- // Determine if 28 is a power of 3
- predicates.is_power(28, 3)
- // Returns Bool: False
-
- // Generate all k = 1 combinations of [1, 2]
- combinatorics.list_combination([1, 2], 1)
- // Returns List: Ok([[1], [2]])
-}
-
-```
-
-## 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
-```