Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak README.md #8

Merged
merged 3 commits into from
May 30, 2024
Merged

Tweak README.md #8

merged 3 commits into from
May 30, 2024

Conversation

mfasi
Copy link
Collaborator

@mfasi mfasi commented May 30, 2024

No description provided.

README.md Outdated
The latest versions of the library have a variety of subtle differences compared with `chop`.
* Since [14 June 2022](https://github.com/higham/chop/commit/1d37238067042416a3554a1f5e6cdd248b613999), `chop` supports specifying the function for generating pseudo-random numbers. The MEX interface of CPFloat does not offer this capability, as the pseudo-random numbers are generated in C and not in MATLAB.
* Since v0.6.0, CPFloat allows users to specify *e*<sub>min</sub> and *e*<sub>max</sub> separately. In earlier versions, users can only specify *e*<sub>max</sub>, while *e*<sub>min</sub> is set to 1 – *e*<sub>max</sub>.
* Since v0.6.0, the default 8-bit format `E4M3` has *e*<sub>max</sub> = 8 and *e*<sub>min</sub> = –6, which is consistent with the homonymous format in the December 2023 revision of the OCP 8-bit Floating Point Specification (OFP8). In `chop`, *e*<sub>max</sub> = 7 and *e*<sub>min</sub> = –6.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, I think.

@mfasi mfasi force-pushed the doc_revision branch 2 times, most recently from c103f69 to 72a1229 Compare May 30, 2024 10:02
@mfasi
Copy link
Collaborator Author

mfasi commented May 30, 2024

I think all open issues related to documentation have been addressed. Ready to merge as far as I am concerned!

@mmikaitis
Copy link
Collaborator

I think all open issues related to documentation have been addressed. Ready to merge as far as I am concerned!

Agreed

@mfasi mfasi merged commit 780b082 into main May 30, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants