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

Remove headroom calculation option from BFP vector initialization. #127

Open
astewart-xmos opened this issue Dec 5, 2022 · 0 comments
Open
Labels
size:S type:enhancement New feature or request version: major incr Major version number increment required. (Change is not backwards-compatible)

Comments

@astewart-xmos
Copy link
Contributor

Currently all forms of bfp_*_init() take a boolean final parameter which indicates whether the vector's headroom should be immediately calculated and set, or if 0 should be used instead.

In hind sight, I don't think this was the right move. The init functions should just set the vector's headroom to 0, and if the user wants to ensure headroom is correct, they can just call bfp_*_headroom() on the vector immediately after. There is no real advantage to combining it into the initialization call, and it makes the explanation of the initialization call just slightly more confusing. Plus I dislike that every call to e.g. bfp_s32_init() ends up having a final argument which is a naked 1 or 0 literal.

Unfortunately this is a backwards compatibility breaking change, and can only really be fixed with a new major version.

@astewart-xmos astewart-xmos added size:S version: major incr Major version number increment required. (Change is not backwards-compatible) labels Dec 5, 2022
@mbanth mbanth added the type:enhancement New feature or request label Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:S type:enhancement New feature or request version: major incr Major version number increment required. (Change is not backwards-compatible)
Projects
None yet
Development

No branches or pull requests

2 participants