Optimize RemoveSimpleEquations

- Change `replaceCrefWithBindExp` to use `UnorderedSet` to reduce the
  amount of allocations.
- Avoid unnecessary allocations in `traverseCrefUnreplaceable`.

Author: perost

OMCompiler/Compiler/BackEnd/RemoveSimpleEquations.mo

@@ -3400,7 +3400,7 @@ algorithm
       Boolean b;
     case(SOME(e), _)
       equation
-        (e, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e, _) = ExpressionSimplify.condsimplify(b, e);
       then
         SOME(e);
@@ -3434,7 +3434,7 @@ algorithm
         equalNonFreeStartValues(values, globalKnownVars, (NONE(), NONE(), cr));
     case (((SOME(e), _))::values, _, (SOME(e2), _, _))
       equation
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
         true = Expression.expEqual(e1, e2);
       then
@@ -3461,54 +3461,64 @@ algorithm
         equalFreeStartValues(values, globalKnownVars, iValue);
     case (((SOME(e), cr))::values, _, (NONE(), _, _))
       equation
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
       then
         equalFreeStartValues(values, globalKnownVars, (SOME(e1), SOME(e), cr));
     // compare
     case (((SOME(e), _))::values, _, (SOME(e2), _, _))
       equation
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
         true = Expression.expEqual(e1, e2);
       then
         equalFreeStartValues(values, globalKnownVars, iValue);
   end match;
 end equalFreeStartValues;
 
-protected function replaceCrefWithBindExp "author: Frenkel TUD 2012-12"
-  input DAE.Exp inExp;
-  input tuple<BackendDAE.Variables, Boolean, HashSet.HashSet> inTuple;
+protected function replaceCrefWithBindExp
+  input DAE.Exp exp;
+  input BackendDAE.Variables vars;
   output DAE.Exp outExp;
-  output tuple<BackendDAE.Variables, Boolean, HashSet.HashSet> outTuple;
+  output Boolean replaced;
+protected
+  UnorderedSet<DAE.ComponentRef> replaced_crefs =
+    UnorderedSet.new(ComponentReference.hashComponentRef, ComponentReference.crefEqual);
 algorithm
-  (outExp,outTuple) := matchcontinue (inExp,inTuple)
-    local
-      DAE.Exp e;
-      BackendDAE.Variables vars;
-      DAE.ComponentRef cr;
-      HashSet.HashSet hs;
+  (outExp, replaced) := Expression.traverseExpBottomUp(exp,
+    function replaceCrefWithBindExp_traverser(vars = vars, replacedCrefs = replaced_crefs), false);
+end replaceCrefWithBindExp;
+
+protected function replaceCrefWithBindExp_traverser
+  input DAE.Exp exp;
+  input Boolean replaced;
+  input BackendDAE.Variables vars;
+  input UnorderedSet<DAE.ComponentRef> replacedCrefs;
+  output DAE.Exp outExp;
+  output Boolean outReplaced;
+protected
+  DAE.ComponentRef cr;
+  DAE.Exp e;
+algorithm
+  (outExp, outReplaced) := matchcontinue (exp, replaced)
     // true if crefs replaced in expression
-    case (DAE.CREF(componentRef=cr), (vars, _, hs))
-      guard
-        // check for cyclic bindings in start value
-        not BaseHashSet.has(cr, hs)
-      equation
-        (BackendDAE.VAR(bindExp = SOME(e)), _) = BackendVariable.getVarSingle(cr, vars);
-        hs = BaseHashSet.add(cr, hs);
-        (e, (_, _, hs)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (vars, false, hs));
-      then
-        (e, (vars, true, hs));
-    // true if crefs in expression
-    case (e as DAE.CREF(), (_, true, _))
-      then
-        (e, inTuple);
-    case (e as DAE.CREF(), (vars, _, hs))
+    case (DAE.CREF(componentRef = cr), _)
+      // check for cyclic bindings in start value
+      guard not UnorderedSet.contains(cr, replacedCrefs)
+      algorithm
+        (BackendDAE.VAR(bindExp = SOME(e)), _) := BackendVariable.getVarSingle(cr, vars);
+        UnorderedSet.add(cr, replacedCrefs);
+        e := Expression.traverseExpBottomUp(e,
+          function replaceCrefWithBindExp_traverser(vars = vars, replacedCrefs = replacedCrefs), false);
       then
-        (e, (vars, true, hs));
-    else (inExp,inTuple);
+        (e, true);
+
+    case (DAE.CREF(), _)
+      then (exp, true);
+
+    else (exp, replaced);
   end matchcontinue;
-end replaceCrefWithBindExp;
+end replaceCrefWithBindExp_traverser;
 
 protected function getZeroFreeValues "author: Frenkel TUD 2012-12"
   input tuple<Option<DAE.Exp>, DAE.ComponentRef> inTpl;
@@ -3600,7 +3610,7 @@ algorithm
       ((e, cr, _)) = selectNonZeroExpression(rest);
       crVar = BackendVariable.varCref(inVar);
       if Flags.isSet(Flags.ALIAS_CONFLICTS) then
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
         s2 = if b then " = " + ExpressionDump.printExpStr(e1) else "";
         s = iStr + "=> Select value from " +  ComponentReference.printComponentRefStr(cr) +  "(" + iAttributeName + " = " + ExpressionDump.printExpStr(e) + s2 + ") for variable: " +  ComponentReference.printComponentRefStr(crVar) + "\n";
@@ -3616,7 +3626,7 @@ algorithm
         i = i + 5;
       end if;
       if Flags.isSet(Flags.ALIAS_CONFLICTS) then
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
         s2 = if b then " = " + ExpressionDump.printExpStr(e1) else "";
         s = iStr + " * Candidate: " + ComponentReference.printComponentRefStr(cr) + "(" + iAttributeName + " = " + ExpressionDump.printExpStr(e) + s2 + ", confidence number = " + intString(i) + ")\n";
@@ -3630,7 +3640,7 @@ algorithm
         i = i + 5;
       end if;
       if Flags.isSet(Flags.ALIAS_CONFLICTS) then
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
         s2 = if b then " = " + ExpressionDump.printExpStr(e1) else "";
         s = iStr + " * Candidate: " + ComponentReference.printComponentRefStr(cr) + "(" + iAttributeName + " = " + ExpressionDump.printExpStr(e) + s2 + ", confidence number = " + intString(i) + ")\n";
@@ -3648,7 +3658,7 @@ algorithm
         i = i + 5;
       end if;
       if Flags.isSet(Flags.ALIAS_CONFLICTS) then
-        (e1, (_, b, _)) = Expression.traverseExpBottomUp(e, replaceCrefWithBindExp, (globalKnownVars, false, HashSet.emptyHashSet()));
+        (e1, b) = replaceCrefWithBindExp(e, globalKnownVars);
         (e1, _) = ExpressionSimplify.condsimplify(b, e1);
         s2 = if b then " = " + ExpressionDump.printExpStr(e1) else "";
         s = iStr + " * Candidate: " + ComponentReference.printComponentRefStr(cr) + "(" + iAttributeName + " = " + ExpressionDump.printExpStr(e) + s2 + ", confidence number = " + intString(i) + ")\n";
@@ -4523,29 +4533,26 @@ algorithm
       HashSet.HashSet unReplaceable;
       Boolean b;
 
-    case (DAE.CREF_QUAL(ident=name, identType=ty, subscriptLst=subs, componentRef=cr), SOME(pcr)) equation
-      (_, b) = Expression.traverseExpTopDownCrefHelper(DAE.CREF_IDENT(name, ty, subs), Expression.traversingComponentRefPresent, false);
-      pcr = if b then ComponentReference.crefPrependIdent(pcr, name, {}, ty) else pcr;
-      unReplaceable = if b then BaseHashSet.add(pcr, iUnreplaceable) else iUnreplaceable;
-      pcr = ComponentReference.crefPrependIdent(pcr, name, subs, ty);
+    case (DAE.CREF_QUAL(ident=name, identType=ty, subscriptLst=subs, componentRef=cr), SOME(pcr)) algorithm
+      (_, b) := Expression.traverseExpTopDownSubs(subs, Expression.traversingComponentRefPresent, false);
+      pcr := if b then ComponentReference.crefPrependIdent(pcr, name, {}, ty) else pcr;
+      unReplaceable := if b then BaseHashSet.add(pcr, iUnreplaceable) else iUnreplaceable;
+      pcr := ComponentReference.crefPrependIdent(pcr, name, subs, ty);
     then traverseCrefUnreplaceable(cr, SOME(pcr), unReplaceable);
 
-    case (DAE.CREF_QUAL(ident=name, identType=ty, subscriptLst=subs, componentRef=cr), NONE()) equation
-      (_, b) = Expression.traverseExpTopDownCrefHelper(DAE.CREF_IDENT(name, ty, subs), Expression.traversingComponentRefPresent, false);
-      pcr = DAE.CREF_IDENT(name, ty, {});
-      unReplaceable = if b then BaseHashSet.add(pcr, iUnreplaceable) else iUnreplaceable;
+    case (DAE.CREF_QUAL(ident=name, identType=ty, subscriptLst=subs, componentRef=cr), NONE()) algorithm
+      (_, b) := Expression.traverseExpTopDownSubs(subs, Expression.traversingComponentRefPresent, false);
+      unReplaceable := if b then BaseHashSet.add(DAE.CREF_IDENT(name, ty, {}), iUnreplaceable) else iUnreplaceable;
     then traverseCrefUnreplaceable(cr, SOME(DAE.CREF_IDENT(name, ty, subs)), unReplaceable);
 
-    case (DAE.CREF_IDENT(ident=name, identType=ty, subscriptLst=subs), SOME(pcr)) equation
-      (_, b) = Expression.traverseExpTopDownCrefHelper(DAE.CREF_IDENT(name, ty, subs), Expression.traversingComponentRefPresent, false);
-      pcr = ComponentReference.crefPrependIdent(pcr, name, {}, ty);
-      unReplaceable = if b then BaseHashSet.add(pcr, iUnreplaceable) else iUnreplaceable;
+    case (DAE.CREF_IDENT(ident=name, identType=ty, subscriptLst=subs), SOME(pcr)) algorithm
+      (_, b) := Expression.traverseExpTopDownSubs(subs, Expression.traversingComponentRefPresent, false);
+      unReplaceable := if b then BaseHashSet.add(ComponentReference.crefPrependIdent(pcr, name, {}, ty), iUnreplaceable) else iUnreplaceable;
     then unReplaceable;
 
-    case (DAE.CREF_IDENT(ident=name, identType=ty, subscriptLst=subs), NONE()) equation
-      (_, b) = Expression.traverseExpTopDownCrefHelper(DAE.CREF_IDENT(name, ty, subs), Expression.traversingComponentRefPresent, false);
-      pcr = DAE.CREF_IDENT(name, ty, {});
-      unReplaceable = if b then BaseHashSet.add(pcr, iUnreplaceable) else iUnreplaceable;
+    case (DAE.CREF_IDENT(ident=name, identType=ty, subscriptLst=subs), NONE()) algorithm
+      (_, b) := Expression.traverseExpTopDownCrefHelper(inCref, Expression.traversingComponentRefPresent, false);
+      unReplaceable := if b then BaseHashSet.add(DAE.CREF_IDENT(name, ty, {}), iUnreplaceable) else iUnreplaceable;
     then unReplaceable;
 
     case (DAE.OPTIMICA_ATTR_INST_CREF(), _) then iUnreplaceable;

OMCompiler/Compiler/FrontEnd/Expression.mo

@@ -7502,7 +7502,7 @@ algorithm
   end match;
 end traverseExpBidirSubs;
 
-protected function traverseExpTopDownSubs
+public function traverseExpTopDownSubs
   input list<DAE.Subscript> inSubscript;
   input FuncType rel;
   input Argument iarg;