Update Input-File.md to describe the Factory Function method of alloc… #1763
Conversation
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
…ating objects from the input file.
hchen99
reviewed
Aug 27, 2024
|
|
||
| The first method is to call the `Trick::MemoryManager` routines to allocate memory. This is the preferred method. | ||
| ### 1. Call `Trick::MemoryManager` allocation routines directly. |
There was a problem hiding this comment.
How about changing it to "Call Trick::MemoryManger Allocation Routines Directly" -- no period and capitalize the first letter of each word to be consistent
|
|
||
| This creates and initializes seven *Ball* objects needed to configure a Newton's cradle. | ||
|
|
||
| ### 3. Call the Wrapped Class Constructor Directly. |
There was a problem hiding this comment.
Either remove the period or add for all other bullets
There was a problem hiding this comment.
Hong demands absolute clarity
| ``` | ||
|
|
||
| Because this function is bound to Python by SWIG, it can be called from the input file. | ||
| For examaple, : |
There was a problem hiding this comment.
Also corrected spelling : examaple --> example
| @@ -188,7 +190,80 @@ food[2] = trick.alloc_type(6, "double") | |||
|
|
|||
| Memory allocated using the above routines are tracked by the memory manager and is checkpointable and data recordable. | |||
|
|
|||
| The second method is to call the wrapped constructor of the class directly. This is analogous to declaring local | |||
| ### 2. Use a Factory Function | |||
| This benefit of this method is flexibility in how objects are initialized. For example, we might want to initialize our objects with a non-default constructor. So, the requirements for our factory function are: | |||
There was a problem hiding this comment.
This benefit --> The benefit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…ating objects from the input file.