FunctionVisitor.hh

Go to the documentation of this file.

#ifndef FUNCTIONVISITOR_HH
#define FUNCTIONVISITOR_HH

#include <iostream>
#include <sstream>
#include <map>
#include "casm/CASM_global_definitions.hh"
#include "casm/container/Array.hh"

namespace CASM {
  class BasisSet;

  class Function;
  class Variable;
  class PolynomialFunction;
  class OccupantFunction;

  class FunctionVisitor {

  public:
    virtual ~FunctionVisitor() {}

    virtual std::string type_name() const = 0;

    virtual bool visit(Variable &host, BasisSet const *bset_ptr)const {
      return false;
    }

    virtual bool visit(OccupantFunction &host, BasisSet const *bset_ptr)const {
      return false;
    }
    virtual bool visit(PolynomialFunction &host, BasisSet const *bset_ptr)const {
      return false;
    }
  private:
    virtual bool _visit(const Array<Function *> &host_list, BasisSet const *bset_ptr)const {

      return false;
    }

  };

  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


  class OccFuncLabeler : public FunctionVisitor {
    Array<std::string> m_sub_strings;
    mutable std::stringstream m_ss;
  public:
    OccFuncLabeler(const std::string &_template);

    std::string type_name() const {
      return "OccFuncLabeler";
    }

    bool visit(OccupantFunction &host, BasisSet const *bset_ptr)const;
  };

  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  class OccFuncBasisIndexer : public FunctionVisitor {
    int m_new_index;
  public:
    OccFuncBasisIndexer(int _new_index) : m_new_index(_new_index) {}

    std::string type_name() const {
      return "OccFuncBasisIndexer";
    }

    bool visit(OccupantFunction &host, BasisSet const *bset_ptr)const;
  };

  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


  class VariableLabeler : public FunctionVisitor {
    Array<std::string> m_sub_strings;
    mutable std::stringstream m_ss;
  public:
    VariableLabeler(const std::string &_template);

    std::string type_name() const {
      return "VariableLabeler";
    }

    bool visit(Variable &host, BasisSet const *bset_ptr)const;
  };

  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  class SubExpressionLabeler : public FunctionVisitor {
    std::string m_bset_name;
    Array<std::string> m_sub_strings;
    mutable std::stringstream m_ss;
  public:
    SubExpressionLabeler(const std::string &_bset_name, const std::string &_template);

    std::string type_name() const {
      return "SubExpressionLabeler";
    }

    bool visit(Variable &host, BasisSet const *bset_ptr)const;

    bool visit(OccupantFunction &host, BasisSet const *bset_ptr)const;

    bool visit(PolynomialFunction &host, BasisSet const *bset_ptr)const;

  private:
    bool _generic_visit(Function &host, BasisSet const *bset_ptr)const;
  };

}
#endif