ENH: Add section "Initializing variables of fixed size array types"#216
Merged
thewtex merged 1 commit intoInsightSoftwareConsortium:mainfrom Dec 17, 2024
Conversation
github-actions
bot
added
type:Enhancement
dzenanz
reviewed
Dec 17, 2024
Suggested by Jon Haitz Legarreta Gorroño at InsightSoftwareConsortium/ITK#5024 (comment)
N-Dekker
force-pushed
the
InitializingVariablesOfFixedSizeArrayTypes
branch
from
5e5f2e5 to
f10846c
Compare
dzenanz
approved these changes
Dec 17, 2024
thewtex
approved these changes
Dec 17, 2024
jhlegarreta
reviewed
Dec 18, 2024
Member
jhlegarreta
left a comment
jhlegarreta
left a comment
There was a problem hiding this comment.
Sorry for my late review. Thanks for doing this @N-Dekker. A few comments inline.
| \code{Index}, \code{Size}, \code{FixedArray}, \code{Point}, and \code{Vector}. | ||
|
|
||
| A variable of such a fixed size array type can be zero-initialized by an empty | ||
| initializer list, `{}`. This is usually the preferred way to initialize the |
Member
There was a problem hiding this comment.
`{}` will not highlight the content in LaTeX as you would expect in Markdown: LaTex uses double backticks at the beginning/upright ticks at the end for ticks, simple backticks will render as opening simple ticks both at the beginning/end. To me, the right thing to use here is \code{}.
| \end{minted} | ||
| \normalsize | ||
|
|
||
| \code{Index} and \code{Size} both have a static `Filled(fillValue)` member |
Member
There was a problem hiding this comment.
Same comment as above about bacticks.
| \end{minted} | ||
| \normalsize | ||
|
|
||
| For other fixed size array types, the function `itk::MakeFilled<T>(fillValue)` |
Member
There was a problem hiding this comment.
Same comment as above about backticks.
N-Dekker
added a commit
to N-Dekker/ITKSoftwareGuide
that referenced
this pull request
Dec 21, 2024
Addressed the comments by Jon Haitz Legarreta Gorroño at InsightSoftwareConsortium#216 (review)
N-Dekker
added a commit
to N-Dekker/ITKSoftwareGuide
that referenced
this pull request
Dec 21, 2024
Addressed the comments by Jon Haitz Legarreta Gorroño at InsightSoftwareConsortium#216 (review) Specifically: > `{}` will not highlight the content in LaTeX as you would expect in Markdown: > LaTex uses double backticks at the beginning/upright ticks at the end for > ticks, simple backticks will render as opening simple ticks both at the > beginning/end.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
STYLE: Replace
T var; var.Fill(x)withauto var = MakeFilled<T>(x)ITK#5024 (comment)