Hoa Nguyen has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/33080 )
Change subject: base: Tag API methods and variables in trie.hh
......................................................................
base: Tag API methods and variables in trie.hh
Change-Id: I4492dbb997a3ece5cb2675b45bf37d7512449ab6
Signed-off-by: Hoa Nguyen <[email protected]>
---
M src/base/trie.hh
1 file changed, 19 insertions(+), 0 deletions(-)
diff --git a/src/base/trie.hh b/src/base/trie.hh
index 71a14c5..7b1343d 100644
--- a/src/base/trie.hh
+++ b/src/base/trie.hh
@@ -114,11 +114,20 @@
Node head;
public:
+ /**
+ * @ingroup api_trie
+ */
typedef Node *Handle;
+ /**
+ * @ingroup api_trie
+ */
Trie() : head(0, 0, NULL)
{}
+ /**
+ * @ingroup api_trie
+ */
static const unsigned MaxBits = sizeof(Key) * 8;
private:
@@ -192,6 +201,8 @@
* @param width How many bits of the key (from msb) should be used.
* @param val A pointer to the value to store in the trie.
* @return A Handle corresponding to this value.
+ *
+ * @ingroup api_trie
*/
Handle
insert(Key key, unsigned width, Value *val)
@@ -278,6 +289,8 @@
* Method which looks up the Value corresponding to a particular key.
* @param key The key to look up.
* @return The first Value matching this key, or NULL if none was
found.
+ *
+ * @ingroup api_trie
*/
Value *
lookup(Key key)
@@ -293,6 +306,8 @@
* Method to delete a value from the trie.
* @param node A Handle to remove.
* @return The Value pointer from the removed entry.
+ *
+ * @ingroup api_trie
*/
Value *
remove(Handle handle)
@@ -337,6 +352,8 @@
* Method to lookup a value from the trie and then delete it.
* @param key The key to look up and then remove.
* @return The Value pointer from the removed entry, if any.
+ *
+ * @ingroup api_trie
*/
Value *
remove(Key key)
@@ -350,6 +367,8 @@
/**
* A method which removes all key/value pairs from the trie. This is
more
* efficient than trying to remove elements individually.
+ *
+ * @ingroup api_trie
*/
void
clear()
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/33080
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I4492dbb997a3ece5cb2675b45bf37d7512449ab6
Gerrit-Change-Number: 33080
Gerrit-PatchSet: 1
Gerrit-Owner: Hoa Nguyen <[email protected]>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
