gem5  v21.1.0.2
mathexpr.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, 2020 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __SIM_MATHEXPR_HH__
39 #define __SIM_MATHEXPR_HH__
40 
41 #include <algorithm>
42 #include <array>
43 #include <functional>
44 #include <string>
45 #include <vector>
46 
47 namespace gem5
48 {
49 
50 class MathExpr
51 {
52  public:
53 
54  MathExpr(std::string expr);
55 
56  typedef std::function<double(std::string)> EvalCallback;
57 
63  std::string toStr() const { return toStr(root, ""); }
64 
72  double eval(EvalCallback fn) const { return eval(root, fn); }
73 
84  {
86  getVariables(root, vars);
87  return vars;
88  }
89 
90  private:
91  enum Operator
92  {
94  };
95 
96  // Match operators
97  const int MAX_PRIO = 4;
98  typedef double (*binOp)(double, double);
99  struct OpSearch
100  {
101  bool binary;
103  int priority;
104  char c;
106  };
107 
109  std::array<OpSearch, uNeg + 1> ops;
110 
111  class Node
112  {
113  public:
114  Node() : op(nInvalid), l(0), r(0), value(0) {}
115  std::string toStr() const {
116  const char opStr[] = {'+', '-', '*', '/', '^', '-'};
117  switch (op) {
118  case nInvalid:
119  return "INVALID";
120  case sVariable:
121  return variable;
122  case sValue:
123  return std::to_string(value);
124  default:
125  return std::string(1, opStr[op]);
126  };
127  }
128 
130  Node *l, *r;
131  double value;
132  std::string variable;
133  };
134 
137 
139  Node *parse(std::string expr);
140 
142  std::string toStr(Node *n, std::string prefix) const;
143 
145  double eval(const Node *n, EvalCallback fn) const;
146 
149  void getVariables(const Node *n, std::vector<std::string> &vars) const;
150 };
151 
152 } // namespace gem5
153 
154 #endif
gem5::MathExpr::eval
double eval(EvalCallback fn) const
Evaluates the expression.
Definition: mathexpr.hh:72
gem5::MathExpr::getVariables
std::vector< std::string > getVariables() const
Return all variables in the this expression.
Definition: mathexpr.hh:83
gem5::MathExpr::parse
Node * parse(std::string expr)
Parse and create nodes from string.
Definition: mathexpr.cc:78
gem5::MathExpr::Node::Node
Node()
Definition: mathexpr.hh:114
gem5::MathExpr::Node::l
Node * l
Definition: mathexpr.hh:130
gem5::MathExpr::sVariable
@ sVariable
Definition: mathexpr.hh:93
gem5::MathExpr::OpSearch::c
char c
Definition: mathexpr.hh:104
gem5::MathExpr::OpSearch::binary
bool binary
Definition: mathexpr.hh:101
gem5::MathExpr::Node::op
Operator op
Definition: mathexpr.hh:129
gem5::MathExpr::bAdd
@ bAdd
Definition: mathexpr.hh:93
sc_dt::to_string
const std::string to_string(sc_enc enc)
Definition: sc_fxdefs.cc:91
gem5::MathExpr::nInvalid
@ nInvalid
Definition: mathexpr.hh:93
gem5::MathExpr::bMul
@ bMul
Definition: mathexpr.hh:93
std::vector< std::string >
gem5::MathExpr::MathExpr
MathExpr(std::string expr)
Definition: mathexpr.cc:50
gem5::MathExpr::ops
std::array< OpSearch, uNeg+1 > ops
Operator list.
Definition: mathexpr.hh:109
gem5::MathExpr::toStr
std::string toStr() const
Prints an ASCII representation of the expression tree.
Definition: mathexpr.hh:63
gem5::MathExpr::OpSearch::fn
binOp fn
Definition: mathexpr.hh:105
gem5::MathExpr::Node::variable
std::string variable
Definition: mathexpr.hh:132
gem5::MathExpr
Definition: mathexpr.hh:50
gem5::MathExpr::bDiv
@ bDiv
Definition: mathexpr.hh:93
gem5::MathExpr::root
Node * root
Root node.
Definition: mathexpr.hh:136
gem5::MathExpr::binOp
double(* binOp)(double, double)
Definition: mathexpr.hh:98
gem5::MathExpr::EvalCallback
std::function< double(std::string)> EvalCallback
Definition: mathexpr.hh:56
gem5::MathExpr::uNeg
@ uNeg
Definition: mathexpr.hh:93
gem5::MathExpr::sValue
@ sValue
Definition: mathexpr.hh:93
gem5::MathExpr::Node::toStr
std::string toStr() const
Definition: mathexpr.hh:115
gem5::MathExpr::bPow
@ bPow
Definition: mathexpr.hh:93
gem5::MathExpr::Node::value
double value
Definition: mathexpr.hh:131
gem5::MathExpr::Operator
Operator
Definition: mathexpr.hh:91
gem5::MathExpr::OpSearch
Definition: mathexpr.hh:99
gem5::MathExpr::Node
Definition: mathexpr.hh:111
gem5::MathExpr::Node::r
Node * r
Definition: mathexpr.hh:130
gem5::MathExpr::OpSearch::op
Operator op
Definition: mathexpr.hh:102
gem5::ArmISA::n
Bitfield< 31 > n
Definition: misc_types.hh:455
gem5::MathExpr::OpSearch::priority
int priority
Definition: mathexpr.hh:103
gem5::MathExpr::bSub
@ bSub
Definition: mathexpr.hh:93
gem5::ArmISA::fn
Bitfield< 18, 16 > fn
Definition: types.hh:149
gem5::MathExpr::MAX_PRIO
const int MAX_PRIO
Definition: mathexpr.hh:97
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

Generated on Tue Sep 21 2021 12:25:48 for gem5 by doxygen 1.8.17