purescript-contrib / purescript-float32

Float32, single-precision 32-bit floating-point number type.

float32

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:

• Open an issue if you have encountered a bug or problem.
• Ask general questions on the PureScript Discourse forum or the PureScript Discord chat.

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

purescript-float32's Issues

NaN?

purescript-float32/src/Data/Float32.purs

Lines 53 to 58 in 3b70984

	-- | Uses `Math.fround()` to convert to a `Float32`.
	-- | Returns *0.0* when outside the range.
	fromNumber' :: Number -> Float32
	fromNumber' x = case fromNumber x of
	Nothing -> Float32 0.0
	Just y -> y

Is NaN a member of the Float32 type?

Maybe this should overflow to NaN rather than 0.0?

Typo in browser compatibility code

I believe there's a typo in Float32.js:

var r = new Float32Array(1); r[0] = s; return r[0];

should be

var r = new Float32Array(1); r[0] = x; return r[0];

Transfer

Hi Athan, would you please transfer this repo to https://github.com/purescript-contrib ? Or transfer it to me so I can transfer it to purescript-contrib?

Regarding purescript-contrib/governance#40