RedBlackTreeMap

RedBlackTreeMap is a final class template defined in Fw/DataStructures. It represents a map based on a red-black tree with internal storage.

1. Template Parameters

RedBlackTreeMap has the following template parameters.

Kind	Name	Purpose
`typename`	`K`	The type of a key in the map
`typename`	`V`	The type of a value in the map
`FwSizeType`	`C`	The capacity, i.e., the maximum number of keys that the map can store

RedBlackTreeMap statically asserts that C > 0.

2. Base Class

RedBlackTreeMap is publicly derived from MapBase<K, V>.

3. Public Types

RedBlackTreeMap defines the following public types:

Name	Definition
`ConstIterator`	Alias of `MapConstIterator<K, V>`
`Node`	Alias of `RedBlackTreeSetOrMapImpl<K, V>::Node`
`Nodes`	Alias of [`Node[C]`
`Index`	Alias of `RedBlackTreeSetOrMapImpl<K, V>::Index`
`FreeNodes`	Alias of [`Index[C]`

4. Private Member Variables

RedBlackTreeMap has the following private member variables.

Name	Type	Purpose	Default Value
`m_extMap`	`ExternalRedBlackTreeMap<K, V>`	The external map implementation	C++ default initialization
`m_nodes`	`Nodes`	The array for storing the tree nodes
`m_freeNodes`	`FreeNodes`	The array for storing the free node indices.

classDiagram
    RedBlackTreeMap *-- ExternalRedBlackTreeMap

5. Public Constructors and Destructors

5.1. Zero-Argument Constructor

RedBlackTreeMap()

Initialize m_extMap with ExternalRedBlackTreeMap<K, V>(m_nodes, m_freeNodes, C).

Example:

RedBlackTreeMap<U16, U32, 10> map;

5.2. Copy Constructor

RedBlackTreeMap(const RedBlackTreeMap<K, V, C>& map)

Initialize m_extMap with ExternalRedBlackTreeMap<K, V>(m_nodes, m_freeNodes, C).
Set *this = map.

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map m1;
// Insert an item
const U16 key = 0;
const U32 value = 42;
const auto status = m1.insert(key, value);
ASSERT_EQ(status, Success::SUCCESS);
// Call the copy constructor
Map m2(m1);
ASSERT_EQ(m2.getSize(), 1);

5.3. Destructor

~RedBlackTreeMap() override

Defined as = default.

6. Public Member Functions

6.1. operator=

RedBlackTreeMap<K, V, C>& operator=(const RedBlackTreeMap<K, V, C>& map)

Return m_extMap.copyDataFrom(map).

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map m1;
// Insert an item
U16 key = 0;
U32 value = 42;
auto status = m1.insert(key, value);
ASSERT_EQ(status, Success::SUCCESS);
// Call the default constructor
Map m2;
ASSERT_EQ(m2.getSize(), 0);
// Call the copy assignment operator
m2 = m1;
ASSERT_EQ(m2.getSize(), 1);
value = 0;
status = m2.find(key, value);
ASSERT_EQ(status, Success::SUCCESS);
ASSERT_EQ(value, 42);

6.2. begin

ConstIterator begin() const

Return m_extMap.begin().

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
// Insert an entry in the map
const auto status = map.insert(0, 1);
ASSERT_EQ(status, Fw::Success::SUCCESS);
// Get a map const iterator object
auto it = map.begin();
// Use the iterator to access the underlying map const entry
const key = it->getKey();
const value = it->getValue();
ASSERT_EQ(key, 0);
ASSERT_EQ(value, 1);

6.3. clear

void clear() override

Call m_extMap.clear().

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
const auto status = map.insert(0, 3);
ASSERT_EQ(map.getSize(), 1);
map.clear();
ASSERT_EQ(map.getSize(), 0);

6.4. end

ConstIterator end() const

Return m_extMap.end().

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
// Call the constructor providing backing storage
Map map;
// Insert an entry in the map
auto status = map.insert(0, 1);
ASSERT_EQ(status, Fw::Success::SUCCESS);
// Get a map const iterator object
auto iter = map.begin();
// Check that iter is not at the end
ASSERT_NE(iter, map.end());
// Increment iter
it++;
// Check that iter is at the end
ASSERT_EQ(iter, map.end());

6.5. find

Success find(const K& key, V& value) override

Return m_extMap.find(key, value).

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
U32 value = 0;
auto status = map.find(0, value);
ASSERT_EQ(status, Success::FAILURE);
status = map.insert(0, 1);
ASSERT_EQ(status, Success::SUCCESS);
status = map.find(0, value);
ASSERT_EQ(status, Success::SUCCESS);
ASSERT_EQ(value, 1);

6.6. getCapacity

FwSizeType getCapacity() const override

Return m_extMap.getCapacity().

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
ASSERT_EQ(map.getCapacity(), 10);

6.8. getSize

FwSizeType getSize() const override

Return m_extMap.getSize().

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
auto size = map.getSize();
ASSERT_EQ(size, 0);
const auto status = map.insert(0, 3);
ASSERT_EQ(status, Success::SUCCESS);
size = map.getSize();
ASSERT_EQ(size, 1);

6.9. insert

Success insert(const K& key, const V& value) override

Return m_extMap.insert(key, value).

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
auto size = map.getSize();
ASSERT_EQ(size, 0);
const auto status = map.insert(0, 1);
ASSERT_EQ(status, Success::SUCCESS);
size = map.getSize();
ASSERT_EQ(size, 1);

6.10. remove

Success remove(const K& key, V& value) override

Return m_extMap.remove(key, value).

Example:

using Map = RedBlackTreeMap<U16, U32, 10>;
Map map;
auto size = map.getSize();
ASSERT_EQ(size, 0);
auto status = map.insert(0, 1);
ASSERT_EQ(status, Success::SUCCESS);
size = map.getSize();
ASSERT_EQ(size, 1);
// Key does not exist
U32 value = 0;
status = map.remove(10, value);
ASSERT_EQ(status, Success::FAILURE);
ASSERT_EQ(size, 1);
// Key exists
status = map.remove(0, value);
ASSERT_EQ(status, Success::SUCCESS);
ASSERT_EQ(size, 0);
ASSERT_EQ(value, 1);