FunctionVisitor.hh

Go to the documentation of this file.

#ifndef FUNCTIONVISITOR_HH
#define FUNCTIONVISITOR_HH
 
#include <iostream>
#include <map>
#include <sstream>
#include <vector>
 
#include "casm/global/definitions.hh"
 
namespace CASM {
class BasisSet;
 
class Function;
class Variable;
class PolynomialFunction;
class OccupantFunction;
 
template <typename T>
class Array;
 
namespace FunctionLabel_impl {
std::pair<bool, std::string> make_label(Function const &host,
                                        BasisSet const *bset_ptr);
}
 
class FunctionVisitor {
 public:
  virtual ~FunctionVisitor() {}
 
  virtual std::string type_name() const = 0;
 
  virtual bool visit(Variable const &host, BasisSet const *bset_ptr) const;
 
  virtual bool visit(Variable &host, BasisSet const *bset_ptr) const;
 
  virtual bool visit(OccupantFunction const &host,
                     BasisSet const *bset_ptr) const;
 
  virtual bool visit(OccupantFunction &host, BasisSet const *bset_ptr) const;
 
  virtual bool visit(PolynomialFunction const &host,
                     BasisSet const *bset_ptr) const;
 
  virtual bool visit(PolynomialFunction &host, BasisSet const *bset_ptr) const;
 
 private:
  virtual bool _generic_visit(Function &host, BasisSet const *bset_ptr) const;
 
  virtual bool _generic_visit(Function const &host,
                              BasisSet const *bset_ptr) const;
 
  virtual bool _visit(const Array<Function *> &host_list,
                      BasisSet const *bset_ptr) const {
    return false;
  }
};
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
class OccFuncLabeler : public FunctionVisitor {
  std::vector<std::string> m_sub_strings;
 
 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 OccFuncEvaluator : public FunctionVisitor {
 public:
  OccFuncEvaluator(int state) : m_state(state) {}
 
  double value() { return m_value; }
 
  std::string type_name() const { return "OccFuncEvaluator"; }
 
  bool visit(OccupantFunction &host, BasisSet const *bset_ptr) const;
 
  bool visit(OccupantFunction const &host, BasisSet const *bset_ptr) const;
 
 private:
  bool _generic_visit(Function const &host, BasisSet const *bset_ptr) const {
    throw std::runtime_error(
        "OccFuncEvaluator can only be applied to OccupantFunction!");
    return false;
  }
 
  int m_state;
  mutable double m_value;
};
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
class VariableLabeler : public FunctionVisitor {
 public:
  VariableLabeler(std::string const &m_type_name, std::string const &_template);
 
  std::string type_name() const { return "VariableLabeler"; }
 
  bool visit(Variable &host, BasisSet const *bset_ptr) const;
 
 private:
  std::string m_type_name;
  std::vector<std::string> m_sub_strings;
};
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
class SubExpressionLabeler : public FunctionVisitor {
 public:
  SubExpressionLabeler(const std::string &_bset_name,
                       const std::string &_template);
 
  SubExpressionLabeler(SubExpressionLabeler const &) = default;
 
  std::string type_name() const { return "SubExpressionLabeler"; }
 
 private:
  bool _generic_visit(Function &host, BasisSet const *bset_ptr) const;
 
  bool _generic_visit(Function const &host, BasisSet const *bset_ptr) const {
    throw std::runtime_error(
        "Application of a SubExpressionLabeler to a const Function is not "
        "allowed!!\n");
  }
 
  std::string m_bset_name;
  std::vector<std::string> m_sub_strings;
};
 
}  // namespace CASM
#endif