-
Notifications
You must be signed in to change notification settings - Fork 26
Interval tree initial documentation and structures defintions #13
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
Interval tree initial documentation and structures defintions #13
Conversation
556c3d7 to
81a6a2a
Compare
studychao
left a comment
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.
Hi Alex, thanks for your work and here is my comments 😄
81a6a2a to
695d974
Compare
andreeaflorescu
left a comment
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.
Chatted with @AlexandruCihodaru offline. Before merging the PR:
- update the allocation_example.png to make it more explicit in terms of state transition and the operations that are generating the change
- include in the design document the design choices and the reasoning behind them: we want to use an interval tree for performance reasons, what are these reasons? where might it be used?
- remove the structure definitions from the design document and replace them with text where that makes sense. This helps with having mostly up to date documentation even when implementation details are changing.
For later (i.e. other PRs):
- examples are better to be placed in src/lib.rs because they are validated at runtime and they don't get so easily outdated.
9bcff4e
695d974 to
9bcff4e
Compare
andreeaflorescu
left a comment
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.
There are quite a few typos and other spell errors in the README. Can you please address them in a future PR?
* Add initial structures definitions. Signed-off-by: AlexandruCihodaru <[email protected]> Co-authored-by: Liu Jiang <[email protected]>
* Started the design and documentation of IntervalTree component of the AddressAllocator. Signed-off-by: AlexandruCihodaru <[email protected]> Co-authored-by: Liu Jiang <[email protected]>
9a402d4
9bcff4e to
9a402d4
Compare
Signed-off-by: AlexandruCihodaru <[email protected]>
9a402d4 to
67661c6
Compare
IntervalTree.IntervalTreeallocation engine.Created a new PR as suggested by @gsserge here