Skip to main content

The Visitor pattern

What is visitor pattern?

1.    It encapsulates an operation executed on an object hierarchy in an object. That says, it allows to add   methods to classes of different types without much altering to those classes.

2.       Enables to define new operations without changing the object hierarchy.

Use-Case:

a. Operations shall be performed on object hierarchy

b. The operations change frequently but object hierarchy is stable.

Basic UML Class Diagram: 

      







Visitor:

· Defines the visit operation on the object structure

    Tax Visitor:

· Implements the visit operation for each type of object

    Visitable:

· Defines the accept operation which takes visitor as an argument

    Visitable Element(s):

               · Implements accept operations

     



The Visitor pattern has two types of hierarchies. The object hierarchy (Visitable elements) and the operation hierarchy (TaxVisitor). The object hierarchy is pretty stable, but operation hierarchy may support different operations on same object hierarchy. In our case Visitor and Visitable acts as interfaces. What does it mean? It means Liquor, Tobacco and Necessity must implement accept member function. Similarly, TaxVisitor must implement overloads of visit function for each object type.

Operation wise, TaxVisitor is applied to object hierarchy. The job of TaxVisitor is to calculate tax based on object type visited. The crucial observation here is an object e.g., Liquor accepts the visitor and uses the visitor to call back the operation hierarchy (visit.visit(*this)), using self as an argument.

Let’s explore the code:

File:  Visitor.h

/*Visitor Interface*/

#pragma once
class Liquor;
class Tobacco;
class Necessity;

class Visitor
{
public:
    virtual double visit(Liquor liquorItem) = 0;
    virtual double visit(Tobacco tobaccoItem) = 0;
    virtual double visit(Necessity necessityItem) = 0;
};

File: TaxVisitor.h
/* Tax Visitor */

#pragma once
#include "Visitor.h"
#include "Liquor.h"
#include "Tobacco.h"
#include "Necessity.h"
#include <fmt/format.h>

class TaxVisitor : public Visitor{
    public:
        TaxVisitor(){}
    public:
        double visit (Liquor liquorItem){
            fmt::print("This is liquor tax\n");
            return ((liquorItem.getPrice() * 0.18) +
                liquorItem.getPrice());
        }
        double visit (Tobacco tobaccoItem){
            fmt::print("This is tobacco tax\n");
            return ((tobaccoItem.getPrice() * 0.28) +
                tobaccoItem.getPrice());
        }
        double visit (Necessity necessityItem){
            fmt::print("This is necessity tax\n");
            return ((necessityItem.getPrice() * 0) +
                necessityItem.getPrice());
        }
};

File: Visitable.h
/* Visitable */
#pragma once
#include "Visitor.h"

class Visitable
{
public:
    virtual double accept(Visitor& visit) = 0;
};

File: Liquor.h
/* Liquor.h */
#pragma once
#include "Visitable.h"

class Liquor :
    public Visitable
{
private:
    double price;

public:
    // CTOR...
    Liquor(double item) {
        price = item;
    }

    double getPrice() {
        return price;
    }

    double accept(Visitor& visit)
    {
        return visit.visit(*this);
    }
};

File: Tobacco.h
/* Tobacco.h */
#pragma once
#include "Visitable.h"
class Tobacco :
    public Visitable
{
private:
    double price;

public:
    // CTOR...
    Tobacco(double item) {
        price = item;
    }

    double getPrice() {
        return price;
    }

    double accept(Visitor& visit)
    {
        return visit.visit(*this);
    }
};


File: Necessity.h
/* Necessity.h */
#pragma once
#include "Visitable.h"
class Necessity :
    public Visitable
{
private:
    double price;

public:
    // CTOR...
    Necessity(double item) {
        price = item;
    }

    double getPrice() {
        return price;
    }

    double accept(Visitor& visit)
    {
        return visit.visit(*this);
    }
};

File: example.cpp
#include "TaxVisitor.h"

int main() {
    TaxVisitor taxCalc;
    Necessity milk(3.47);
    fmt::print("{}\n", milk.accept(taxCalc));

    Liquor wine(11.20);
    fmt::print("{}\n", wine.accept(taxCalc));

    Tobacco cig(19.89);
    fmt::print("{}\n", cig.accept(taxCalc));
    return 0;
}


Demo (This is same demo code on compiler explorer)
Credit: Design Patterns: Elements of Reusable Object-Oriented Software (By GoF),
        Rainer Grimm & Derek Banas


Labels:

Comments

Post a Comment

Popular posts from this blog

Reversing char array without splitting the array to tokens

 I was reading about strdup, a C++ function and suddenly an idea came to my mind if this can be leveraged to aid in reversing a character array without splitting the array into words and reconstructing it again by placing spaces and removing trailing spaces. Again, I wanted an array to be passed as a function argument and an array size to be passed implicitly with the array to the function. Assumed, a well-formed char array has been passed into the function. No malformed array checking is done inside the function. So, the function signature and definition are like below: Below is the call from the client code to reverse the array without splitting tokens and reconstructing it. Finally, copy the reversed array to the destination.  For GNU C++, we should use strdup instead _strdup . On run, we get the following output: Demo code
Post a Comment
Read more

XOR (Exclusive OR) for branchless coding

The following example shows the array reversing using the  XOR operator . No need to take any additional variable to reverse the array.   int main(int argc, _TCHAR* argv[]) { char str[] = "I AM STUDENT"; int length = strlen(str); for(int i = 0; i < ((length/2)); i++) { str[i] ^= str[length - (1+i)]; str[length - (1+i)] ^= str[i]; str[i] ^= str[length - (1+i)]; } cout << str << endl; return 0; } The above example is one of the uses of XOR but XOR comes in handy when we can do branchless coding  methods like butterfly switch etc. Sometimes this is very effective in speeding up the execution.  Let's see one of the uses of XOR in branchless coding. I am taking a simple example of Y = | X |.  Yes, I am generating abs of a supplied number. So, my function signature/definition in C++ looks like below: int absoluteBranch( int x) {     if (x < 0 ) {         return -x;     }     else {         retur
1 comment
Read more

Power of Two

  I n this post will be discussing how to calculate if a number is a power of two or not. As an example, 8 is a power of two but the number 10 is not. There are many ways we can solve this. First , we will take an approach which is simple and iterative. In this case, we will calculate the power of two one by one and check with the supplied number. The below code illustrates it. bool isPowerofTwo(unsigned num) { auto y = 1; while (0 != y) { if (num == y) return true; if (num < y) return false; y <<= 1; } return false; } Second , assuming, the number is a 32-bit number, this is also an iterative solution. In this scenario, iterating all bits and counting the set bits. Any number which is a power of 2 will have only one bit set and the rest will be zeros. As an example, 8 in binary representation is 1000. Using this observation, we can implement an iterative solution. bool isPowerofTwo(unsigned num) { auto one_count = 0; for (auto index = 0; index < 32;
Post a Comment
Read more