-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
dev: add floating-point-annotation and mul-vs-div to style guide #2705
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -467,3 +467,36 @@ The user field helps to categorize and hide advanced parameters from being adjus | |
|
||
- Standard - Available to anyone | ||
- Advanced - Available to advanced users | ||
|
||
Floating Point Annotation | ||
========================= | ||
|
||
ArduPilot is compiled with ``-fsingle-precision-constant``. | ||
|
||
That means it is currently allowable to leave off the float specifier from constants. It is also permissable to have them. | ||
|
||
**Right** | ||
|
||
:: | ||
|
||
1.0f | ||
1.0 | ||
|
||
Multiplication vs Division | ||
========================== | ||
|
||
Use multiplication rather than division where possible: | ||
|
||
**Right** | ||
|
||
:: | ||
|
||
const float foo_m = foo_cm * 0.01; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 0.01f ;-P |
||
|
||
**Wrong** | ||
|
||
:: | ||
|
||
const float foo_m = foo_cm / 100; | ||
|
||
Multiplications typically take fewer cycles to compute than divisions. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather say : please use them ... otherwise when we will actually need double we will have issues !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I disagree, it makes the code harder to read