feat: add expected_scope_depth

Author: AayushSabharwal

src/utils.jl

@@ -639,6 +639,23 @@ function check_scope_depth(scope, depth)
     end
 end
 
+"""
+    $(TYPEDSIGNATURES)
+
+Return the expected depth of the given `SymScope` from the root system.
+"""
+function expected_scope_depth(scope)
+    if scope isa LocalScope
+        return 0
+    elseif scope isa ParentScope
+        return expected_scope_depth(scope.parent) + 1
+    elseif scope isa DelayParentScope
+        return expected_scope_depth(scope.parent) + scope.N + 1
+    elseif scope isa GlobalScope
+        return -1
+    end
+end
+
 """
 Find all the symbolic constants of some equations or terms and return them as a vector.
 """