Package

purescript-float32

Repository
purescript-contrib/purescript-float32
License
BSD-3-Clause
Uploaded by
jamesdbrock
Published on
2021-07-10

CI Release Pursuit Maintainer: jamesdbrock

Provides the 32-bit single-precision floating-point data type Float32 and operations.

Float32 is a newtype wrapper around Number, where entering into the type can only be done with Math.fround().

Installation

Install float32 with Spago:

spago install float32

Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the docs directory.

Documentation

float32 documentation is stored in a few places:

  1. Module documentation is published on Pursuit.
  2. Written documentation is kept in the docs directory.
  3. Usage examples can be found in the test suite.

If you get stuck, there are several ways to get help:

Contributing

You can contribute to float32 in several ways:

  1. If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.

  2. If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.

  3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.

Development

Run the tests with

spago -x test.dhall test