Composite Design Pattern in Modern C++
Tags: cpp, design, tutorial, computerscience
Published: 2020-08-31 13:25:56

[GoF](https://en.wikipedia.org/wiki/Design_Patterns) describes the Composite Design Pattern as "Compose objects into a tree structure to represent part-whole hierarchies. Composite lets the client treat individual objects and compositions of objects uniformly". This seems over-complicated to me. So, I would not go into tree-leaf kind of jargon. Rather I directly saw you 2 or 3 different ways to implement Composite Design Pattern in Modern C++. But in simple words, the Composite Design Pattern is a Structural Design Pattern with a goal ***to treat the group of objects in the same manner as a single object***.



> /!\\\: This article has been originally published on my [blog](http://www.vishalchovatiya.com/composite-design-pattern-in-modern-cpp/). If you are interested in receiving my latest articles, [please sign up to my newsletter](http://eepurl.com/gDNybv).


By the way, If you haven't check out my other articles on Structural Design Patterns, then here is the list:

1.  **[Adapter](http://www.vishalchovatiya.com/adapter-design-pattern-in-modern-cpp/)**
2.  **[Bridge](http://www.vishalchovatiya.com/bridge-design-pattern-in-modern-cpp/)**
3.  **[Composite](http://www.vishalchovatiya.com/composite-design-pattern-in-modern-cpp/)**
4.  **[Decorator](http://www.vishalchovatiya.com/decorator-design-pattern-in-modern-cpp/)**
5.  **[Facade](http://www.vishalchovatiya.com/facade-design-pattern-in-modern-cpp/)**
6.  **[Flyweight](http://www.vishalchovatiya.com/flyweight-design-pattern-in-modern-cpp/)**
7.  **[Proxy](http://www.vishalchovatiya.com/proxy-design-pattern-in-modern-cpp/)**

The code snippets you see throughout this series of articles are simplified not sophisticated. So you often see me not using keywords like `override`, `final`, `public`(while inheritance) just to make code compact & consumable(most of the time) in single standard screen size. I also prefer `struct` instead of `class` just to save line by not writing "`public:`" sometimes and also miss [virtual destructor](http://www.vishalchovatiya.com/part-3-all-about-virtual-keyword-in-c-how-virtual-destructor-works/), constructor, [copy constructor](http://www.vishalchovatiya.com/all-about-copy-constructor-in-cpp-with-example/), prefix `std::`, deleting dynamic memory, intentionally. I also consider myself a pragmatic person who wants to convey an idea in the simplest way possible rather than the standard way or using Jargons.

***Note:***

-   If you stumbled here directly, then I would suggest you go through [What is design pattern?](http://www.vishalchovatiya.com/what-is-design-pattern/) first, even if it is trivial. I believe it will encourage you to explore more on this topic.
-   All of this code you encounter in this series of articles are compiled using C++20(though I have used [Modern C++](http://www.vishalchovatiya.com/21-new-features-of-modern-cpp-to-use-in-your-project/) features up to C++17 in most cases). So if you don't have access to the latest compiler you can use <https://wandbox.org/> which has preinstalled boost library as well.



Intent
------

> ***To treat individual & group of objects in a uniform manner.***

![](https://dev-to-uploads.s3.amazonaws.com/i/o9e4n60vdpyg1wpbloo3.png)

-   So what is it all about and why do we need it. Well, we know that objects typically use other objects fields or properties or members through either inheritance or composition.
-   For example, in drawing applications, you have a `Shape`(e.g. `Circle`) that you can draw on the screen but you can also have a group of `Shape`s(e.g. `vector<Circle>`) which inherits from a collection `Shape`.
-   And they have certain common API which you can then call on one or the other without knowing in advance whether you're working with a single element or with the entire collection.

Composite Design Pattern Examples in C++
----------------------------------------

-   So if you think about an application such as PowerPoint or any kind of vector drawing application you know that you can draw & drag individual shapes around.
-   But you can also group shapes together. And when you group several shapes together you can treat them as if they were a single shape. So you can grab the entire thing and also drag it and resize it and whatnot.
-   So, we're going to implement the Composite Design Pattern around this idea of several different shapes.

### Classical Composite Design Pattern

```C++
struct Shape {
    virtual void draw() = 0;
};

struct Circle : Shape {
    void draw() { cout << "Circle" << endl; }
};

struct Group : Shape {
    string              m_name;
    vector<Shape*>      m_objects;

    Group(const string &n) : m_name{n} {}

    void draw() {
        cout << "Group " << m_name.c_str() << " contains:" << endl;
        for (auto &&o : m_objects)
            o->draw();
    }
};

int main() {
    Group root("root");
    root.m_objects.push_back(new Circle);

    Group subgroup("sub");
    subgroup.m_objects.push_back(new Circle);

    root.m_objects.push_back(&subgroup);
    root.draw();

    return EXIT_SUCCESS;
}
/*
Group root contains:
Circle
Group sub contains:
Circle
*/
```

Composite Design Pattern using Curiously Recurring Template Pattern(CRTP)
-------------------------------------------------------------------------

-   As you've probably noticed machine learning is a really hot topic nowadays. And part of the machine learning mechanics is to use of neural networks so that's what we're going to take a look at now.

```C++
struct Neuron {
    vector<Neuron*>     in, out;
    uint32_t            id;

    Neuron() {
        static int id = 1;
        this->id = id++;
    }

    void connect_to(Neuron &other) {
        out.push_back(&other);
        other.in.push_back(this);
    }

    friend ostream &operator<<(ostream &os, const Neuron &obj) {
        for (Neuron *n : obj.in)
            os << n->id << "\t-->\t[" << obj.id << "]" << endl;

        for (Neuron *n : obj.out)
            os << "[" << obj.id << "]\t-->\t" << n->id << endl;

        return os;
    }
};

int main() {
    Neuron n1, n2;
    n1.connect_to(n2);
    cout << n1 << n2 << endl;
    return EXIT_SUCCESS;
}
/* Output
[1]    -->    2
1    -->    [2]
*/
```
-   As you can see we have a neuron structure which has connections to other neurons that modelled as vectors of pointers for input-output neuron connection. This is a very basic implementation and it works just fine as long as you just have individual neurons. Now the one thing that we haven't accounted for is what happens when you have more than one neuron or group of neurons to connect.
-   Let's suppose that we decide to make a neuron layer and now a layer of neurons is basically like a collection.

```C++
struct NeuronLayer : vector<Neuron> {
    NeuronLayer(int count) {
        while (count-- > 0)
            emplace_back(Neuron{});
    }

    friend ostream &operator<<(ostream &os, NeuronLayer &obj) {
        for (auto &n : obj)
            os << n;
        return os;
    }
};

int main() {
    NeuronLayer l1{1}, l2{2};
    Neuron n1, n2;
    n1.connect_to(l1);  // Neuron connects to Layer
    l2.connect_to(n2);  // Layer connects to Neuron
    l1.connect_to(l2);  // Layer connects to Layer
    n1.connect_to(n2);  // Neuron connects to Neuron

    return EXIT_SUCCESS;
}
```

-   Now as you probably guessed if you were to implement this head-on you're going to have a total of four different functions. i.e.

```C++
Neuron::connect_to(NeuronLayer&)
NeuronLayer::connect_to(Neuron&)
NeuronLayer::connect_to(NeuronLayer&)
Neuron::connect_to(Neuron&)
```

-   So this is state-space explosion & permutation problem and it's not good because we want a single function that enumerable both the layer as well as individual neurons.

```C++
template <typename Self>
struct SomeNeurons {
    template <typename T>
    void connect_to(T &other);
};

struct Neuron : SomeNeurons<Neuron> {
    vector<Neuron*>     in, out;
    uint32_t            id;

    Neuron() {
        static int id = 1;
        this->id = id++;
    }

    Neuron* begin() { return this; }
    Neuron* end() { return this + 1; }
};

struct NeuronLayer : vector<Neuron>, SomeNeurons<NeuronLayer> {
    NeuronLayer(int count) {
        while (count-- > 0)
            emplace_back(Neuron{});
    }
};

template <typename Self>
template <typename T>
void SomeNeurons<Self>::connect_to(T &other) {
    for (Neuron &from : *static_cast<Self *>(this)) {
        for (Neuron &to : other) {
            from.out.push_back(&to);
            to.in.push_back(&from);
        }
    }
}

template <typename Self>
ostream &operator<<(ostream &os, SomeNeurons<Self> &object) {
    for (Neuron &obj : *static_cast<Self *>(&object)) {
        for (Neuron *n : obj.in)
            os << n->id << "\t-->\t[" << obj.id << "]" << endl;

        for (Neuron *n : obj.out)
            os << "[" << obj.id << "]\t-->\t" << n->id << endl;
    }
    return os;
}

int main() {
    Neuron n1, n2;
    NeuronLayer l1{1}, l2{2};

    n1.connect_to(l1); // Scenario 1: Neuron connects to Layer
    l2.connect_to(n2); // Scenario 2: Layer connects to Neuron
    l1.connect_to(l2); // Scenario 3: Layer connects to Layer
    n1.connect_to(n2); // Scenario 4: Neuron connects to Neuron

    cout << "Neuron " << n1.id << endl << n1 << endl;
    cout << "Neuron " << n2.id << endl << n2 << endl;

    cout << "Layer " << endl << l1 << endl;
    cout << "Layer " << endl << l2 << endl;

    return EXIT_SUCCESS;
}
/* Output
Neuron 1
[1]    -->    3
[1]    -->    2

Neuron 2
4    -->    [2]
5    -->    [2]
1    -->    [2]

Layer 
1    -->    [3]
[3]    -->    4
[3]    -->    5

Layer 
3    -->    [4]
[4]    -->    2
3    -->    [5]
[5]    -->    2
*/
```

-   As you can see we have covered all four different permutation scenarios using a single `SomeNeurons::connect_to` method with the help of CRTP. And both `Neuron` & `NeuronLayer` conforms to this interface via self templatization.
-   **C**uriously **R**ecurring **T**emplate **P**attern comes handy here & has very straight implementation rule i.e. ***separate out the type-dependent & independent functionality and bind type* *independent functionality with the base class using self-referencing template***.
-   I have written a separate article on [Advanced C++ Concepts & Idioms](http://www.vishalchovatiya.com/7-advanced-cpp-concepts-idiom-examples-you-should-know/) including CRTP.

Benefits of Composite Design Pattern
------------------------------------

1.  Reduces code complexity by eliminating many loops over the homogeneous collection of objects.
2.  This intern increases the maintainability & testability of code with fewer chances to break existing running & tested code.
3.  The relationship is described in the Composite Design Pattern isn't a subclass relationship, it's a collection relationship. Which means client/API-user does not need to care about operations(like translating, rotating, scaling, drawing, etc.) whether it is a single [object](http://www.vishalchovatiya.com/inside-the-cpp-object-model/) or an entire collection.

Summary by FAQs
---------------

**When should I use the Composite Design Pattern?**

-- You want clients to be able to ignore the difference between the group of objects and individual objects.
-- When you find that you are using multiple objects in the same way, and looping over to perform a somewhat similar action, then composite is a good choice.

**What is the common example of the Composite Design Pattern?**

-- File & Folder(collection of files): Here File is a single class. Folder inherits File and holds a collection of Files.

**What is the difference between Decorator & Composite Design Pattern?**

-- Decorator works on enhancing interface.
-- Composition works to unify interfaces for single & group of objects.