Hoa Nguyen has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/32956 )
Change subject: base: Tag API methods and variables in addr_range_map.hh
......................................................................
base: Tag API methods and variables in addr_range_map.hh
Change-Id: I9dc630e7c0d0826a20f032879346da6327b38a2d
Signed-off-by: Hoa Nguyen <hoangu...@ucdavis.edu>
---
M src/base/addr_range_map.hh
1 file changed, 47 insertions(+), 0 deletions(-)
diff --git a/src/base/addr_range_map.hh b/src/base/addr_range_map.hh
index d9a0981..71a7c23 100644
--- a/src/base/addr_range_map.hh
+++ b/src/base/addr_range_map.hh
@@ -62,8 +62,13 @@
typedef std::map<AddrRange, V> RangeMap;
public:
+ /**
+ * @ingroup api_addr_range_map
+ * @{
+ */
typedef typename RangeMap::iterator iterator;
typedef typename RangeMap::const_iterator const_iterator;
+ /** @} */ // end of api_addr_range_map
/**
* Find entry that contains the given address range
@@ -74,6 +79,9 @@
*
* @param r An input address range
* @return An iterator that contains the input address range
+ *
+ * @ingroup api_addr_range_map
+ * @{
*/
const_iterator
contains(const AddrRange &r) const
@@ -85,6 +93,7 @@
{
return find(r, [r](const AddrRange r1) { return r.isSubset(r1); });
}
+ /** @} */ // end of api_addr_range_map
/**
* Find entry that contains the given address
@@ -95,6 +104,9 @@
*
* @param r An input address
* @return An iterator that contains the input address
+ *
+ * @ingroup api_addr_range_map
+ * @{
*/
const_iterator
contains(Addr r) const
@@ -106,6 +118,7 @@
{
return contains(RangeSize(r, 1));
}
+ /** @} */ // end of api_addr_range_map
/**
* Find entry that intersects with the given address range
@@ -116,6 +129,9 @@
*
* @param r An input address
* @return An iterator that intersects with the input address range
+ *
+ * @ingroup api_addr_range_map
+ * @{
*/
const_iterator
intersects(const AddrRange &r) const
@@ -127,7 +143,11 @@
{
return find(r, [r](const AddrRange r1) { return r.intersects(r1);
});
}
+ /** @} */ // end of api_addr_range_map
+ /**
+ * @ingroup api_addr_range_map
+ */
iterator
insert(const AddrRange &r, const V& d)
{
@@ -137,6 +157,9 @@
return tree.insert(std::make_pair(r, d)).first;
}
+ /**
+ * @ingroup api_addr_range_map
+ */
void
erase(iterator p)
{
@@ -144,6 +167,9 @@
tree.erase(p);
}
+ /**
+ * @ingroup api_addr_range_map
+ */
void
erase(iterator p, iterator q)
{
@@ -153,6 +179,9 @@
tree.erase(p,q);
}
+ /**
+ * @ingroup api_addr_range_map
+ */
void
clear()
{
@@ -160,36 +189,54 @@
tree.erase(tree.begin(), tree.end());
}
+ /**
+ * @ingroup api_addr_range_map
+ */
const_iterator
begin() const
{
return tree.begin();
}
+ /**
+ * @ingroup api_addr_range_map
+ */
iterator
begin()
{
return tree.begin();
}
+ /**
+ * @ingroup api_addr_range_map
+ */
const_iterator
end() const
{
return tree.end();
}
+ /**
+ * @ingroup api_addr_range_map
+ */
iterator
end()
{
return tree.end();
}
+ /**
+ * @ingroup api_addr_range_map
+ */
std::size_t
size() const
{
return tree.size();
}
+ /**
+ * @ingroup api_addr_range_map
+ */
bool
empty() const
{
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/32956
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: I9dc630e7c0d0826a20f032879346da6327b38a2d
Gerrit-Change-Number: 32956
Gerrit-PatchSet: 1
Gerrit-Owner: Hoa Nguyen <hoangu...@ucdavis.edu>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
