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

Write function O-notation in prettier way using latex #55

Open
chshersh opened this issue Sep 21, 2018 · 8 comments
Open

Write function O-notation in prettier way using latex #55

chshersh opened this issue Sep 21, 2018 · 8 comments
Labels
docs good first issue Hacktoberfest https://hacktoberfest.digitalocean.com/

Comments

@chshersh
Copy link
Contributor

Haddock supports that.

@chshersh chshersh added the docs label Sep 21, 2018
@vrom911 vrom911 added good first issue Hacktoberfest https://hacktoberfest.digitalocean.com/ labels Sep 30, 2018
@cronokirby
Copy link

Where exactly are the ocurrences of this?

@chshersh
Copy link
Contributor Author

chshersh commented Oct 4, 2018

@cronokirby The functions that require documentation improvements are here:

The same should be done for TMap module:

You can see example of how asymptotic specified in this PR:

@chshersh chshersh removed the Hacktoberfest https://hacktoberfest.digitalocean.com/ label Nov 7, 2018
@vrom911 vrom911 added the Hacktoberfest https://hacktoberfest.digitalocean.com/ label Sep 29, 2019
@0xd34df00d
Copy link

I guess I can give this a shot.

@chshersh
Copy link
Contributor Author

chshersh commented Oct 9, 2019

Hi @0xd34df00d! Did you have time to work on this? Let us know if you stuck on something and need some further details or clarifications 🙂

@0xd34df00d
Copy link

@chshersh oh, I realized there're no complexity annotations right now, and I don't think I'm qualified enough to produce them off the top of my head! Did I miss something by any chance?

@chshersh
Copy link
Contributor Author

@0xd34df00d Hmm, indeed, I can see how this can be challenging. No worries then! 🙂

@ChrisPenner
Copy link
Collaborator

@chshersh @0xd34df00d I've been adding complexity annotations as I touch functions and think I probably have the context loaded up to just go through and add them all if that'd help here.

There are a few spots where some additional explanation is needed due to optimizations (at least after the work in a few of my other PRs); for instance alter changes its asymptotics based on the function you pass it; all operations have a base log factor, then if you delete it's O(n); if you update it's O(1), if you insert it's O(n) haha; so the function itself technically has a worst bound of O(n); but can be O(1) in many common cases 🤷 .

At any rate; some explanation is likely better than no explanation 😄

@chshersh
Copy link
Contributor Author

@ChrisPenner Thanks for working on this! I believe, only a few functions will require O-notation annotations after your awesome work 💪

Haddock supports LaTeX, and I'd love to have O-notations formatted using pretty formulas as we did in relude for the Nub module for example:

@chshersh chshersh added this to the v0.4.0.0: Boost milestone Oct 17, 2020
@chshersh chshersh removed this from the v0.4.0.0: Boost milestone Aug 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs good first issue Hacktoberfest https://hacktoberfest.digitalocean.com/
Projects
None yet
Development

No branches or pull requests

5 participants