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

mismatch between ec_dec_uint doc and code #54

Closed
est31 opened this issue Jul 13, 2017 · 1 comment
Closed

mismatch between ec_dec_uint doc and code #54

est31 opened this issue Jul 13, 2017 · 1 comment

Comments

@est31
Copy link

est31 commented Jul 13, 2017

Minor nit.

In the documentation of the ec_dec_uint function, there is a note that the param "must be at least one, and no more than 2**32-1", so >= 1. In the implementation of the function we have the following:

opus_uint32 ec_dec_uint(ec_dec *_this,opus_uint32 _ft){
  /* [...] */
  /*In order to optimize EC_ILOG(), it is undefined for the value 0.*/
  celt_assert(_ft>1);

... so requiring >1 for the param.

@jmvalin
Copy link
Member

jmvalin commented Oct 8, 2017

Doc fixed (assert was correct)

@jmvalin jmvalin closed this as completed Oct 8, 2017
ghost pushed a commit that referenced this issue Oct 8, 2017
Addresses issue #54
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

No branches or pull requests

2 participants