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

Clarify documentation for comboIter and permuteIter #15

Open
jwood000 opened this issue Jun 11, 2020 · 1 comment
Open

Clarify documentation for comboIter and permuteIter #15

jwood000 opened this issue Jun 11, 2020 · 1 comment

Comments

@jwood000
Copy link
Owner

Currently, in the many examples involving combo/permuteIter, we take advantage of the fact that they return FALSE when iteration is complete, however it isn't documented anywhere.

Could we explicitly document this and maybe add more explanation behind the motivation of this design?

@jwood000 jwood000 changed the title Clarify documentation for combo/permuteIter Clarify documentation for comboIter and permuteIter Jun 11, 2020
@jwood000
Copy link
Owner Author

We changed how iterators are handled by in db7cce2.

Instead of returning FALSE when iteration has been exhausted, we return NULL.

We initially thought that returning a logical made sense as it was in line with std::next_permutation from C++, however this causes problems when the source vector is logical or the FUN parameter is a logical check.

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

1 participant