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

fix:fit binary-exponent.cpp to guidelines #2463

Closed
wants to merge 16 commits into from

Conversation

ewd00010
Copy link
Contributor

Description of Change

FIX: added checking for negative exponents to both functions. Removed user interaction and replaced with tests function.

CHORE: added author, reformatted function documentation, added descriptions of what is happening in each algo and adhered to other repo standards

Checklist

  • Added description of change
  • Added file name matches File name guidelines
  • Added tests and example, test must pass
  • Added documentation so that the program is self-explanatory and educational - Doxygen guidelines
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • I acknowledge that all my contributions will be made under the project's license.

Notes: Should we keep formatting text like \f$O(\log(n))\f$ in the comments or should they be removed?
Additionally i cant seem to get clang-tidy to work on my system, this code will need a once over with it

FIX: added checking for negative exponents to both functions. Removed user interaction and repalced with tests function.

CHORE: added author, reformatted function documentation, added descriptions of what is happening in each algo and adhered to other repo standards
math/binary_exponent.cpp Outdated Show resolved Hide resolved
@realstealthninja
Copy link
Collaborator

We use \f$ to render latex math equations they are necessary and imo should be required as they make the equations professional and presentable for more details check out doxygen's documentation on latex equations

ewd00010 and others added 2 commits May 23, 2023 17:44
Co-authored-by: realstealthninja <68815218+realstealthninja@users.noreply.github.com>
Co-authored-by: realstealthninja <68815218+realstealthninja@users.noreply.github.com>
@realstealthninja
Copy link
Collaborator

part of #2456

Copy link
Collaborator

@realstealthninja realstealthninja left a comment

Choose a reason for hiding this comment

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

Looks good! thank you so much for your contributions ❤️

@Panquesito7 Panquesito7 added enhancement New feature or request automated tests are failing Do not merge until tests pass labels May 31, 2023
Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

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

For more details, you can check the clang-tidy warnings.
If you need any help fixing those, let us know. 🙂

math/binary_exponent.cpp Outdated Show resolved Hide resolved
math/binary_exponent.cpp Outdated Show resolved Hide resolved
math/binary_exponent.cpp Outdated Show resolved Hide resolved
math/binary_exponent.cpp Outdated Show resolved Hide resolved
math/binary_exponent.cpp Outdated Show resolved Hide resolved
ewd00010 and others added 4 commits June 3, 2023 14:24
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
also one or two small wording changes
math/binary_exponent.cpp Outdated Show resolved Hide resolved
math/binary_exponent.cpp Outdated Show resolved Hide resolved
math/binary_exponent.cpp Outdated Show resolved Hide resolved
new assert test, new guard clauses ( now in both functions ), binary shift now in iterative function instead of /=2, base numbers can now be negative (exponents still unsigned if that's ok?)
@Panquesito7 Panquesito7 removed the automated tests are failing Do not merge until tests pass label Jun 8, 2023
ewd00010 and others added 2 commits June 10, 2023 14:56
Co-authored-by: David Leal <halfpacho@gmail.com>
small fix to assert test
Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

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

Awesome. Thanks! 🚀

Copy link
Collaborator

@realstealthninja realstealthninja left a comment

Choose a reason for hiding this comment

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

LGTM!

@realstealthninja
Copy link
Collaborator

realstealthninja commented Jun 16, 2023

just one conversation to resolve and you are good to go! @tjgurwara99

@Panquesito7
Copy link
Member

Will be merging in a few days if there are no objections. Ping me in case I forget.

@github-actions
Copy link
Contributor

This pull request has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale Author has not responded to the comments for over 2 weeks label Aug 19, 2023
@realstealthninja
Copy link
Collaborator

@Panquesito7

@github-actions github-actions bot removed the stale Author has not responded to the comments for over 2 weeks label Aug 20, 2023
@github-actions
Copy link
Contributor

This pull request has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale Author has not responded to the comments for over 2 weeks label Sep 19, 2023
@github-actions
Copy link
Contributor

Please ping one of the maintainers once you commit the changes requested or make improvements on the code. If this is not the case and you need some help, feel free to ask for help in our Gitter channel or our Discord server. Thank you for your contributions!

@github-actions github-actions bot closed this Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request stale Author has not responded to the comments for over 2 weeks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants