Merge pull request #23 from rhennigan/feature/custom-rule-specifications

Custom rule specifications and misc Bug fixes
rhennigan · Jun 22, 2023 · 472fa11 · 472fa11
2 parents 9e368fe + 6f3e251
commit 472fa11
Show file tree

Hide file tree

Showing 28 changed files with 3,999 additions and 2,655 deletions.
diff --git a/Data/RuleSets/Arithmetic.wl b/Data/RuleSets/Arithmetic.wl
@@ -43,7 +43,7 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
-    "Name"        -> "Arithmetic-deiVLm",
+    "Name"        -> "Plus-0",
     "Description" -> "Transform using basic arithmetic rules",
     "Usage"       -> { "EquivalenceTesting", "Simplification", "Optimization" },
     "Symbols"     :> { Plus },
@@ -52,7 +52,16 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
-    "Name"        -> "Arithmetic-cJntVW",
+    "Name"        -> "Plus-1",
+    "Description" -> "Simplify Plus expressions with one argument",
+    "Usage"       -> { "EquivalenceTesting", "Simplification", "Optimization" },
+    "Symbols"     :> { Plus },
+    "Rule"        :> Verbatim[ Plus ][ x_ ] :> x
+|>
+
+(**********************************************************************************************************************)
+<|
+    "Name"        -> "Times-0",
     "Description" -> "Transform using basic arithmetic rules",
     "Usage"       -> { "EquivalenceTesting", "Simplification", "Optimization" },
     "Symbols"     :> { Times },
@@ -61,8 +70,17 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
-    "Name"        -> "Arithmetic-bjzLyg",
-    "Description" -> "Transform using basic arithmetic rules",
+    "Name"        -> "Times-1",
+    "Description" -> "Simplify Times expressions with one argument",
+    "Usage"       -> { "EquivalenceTesting", "Simplification", "Optimization" },
+    "Symbols"     :> { Times },
+    "Rule"        :> Verbatim[ Times ][ x_ ] :> x
+|>
+
+(**********************************************************************************************************************)
+<|
+    "Name"        -> "Power-1",
+    "Description" -> "Simplify Power expressions with one argument",
     "Usage"       -> { "EquivalenceTesting", "Simplification", "Optimization" },
     "Symbols"     :> { Power },
     "Rule"        :> Power[ x_ ] :> x

diff --git a/Data/RuleSets/Attributes.wl b/Data/RuleSets/Attributes.wl
@@ -43,6 +43,7 @@ SetRuleDefaults @ <|
 (**********************************************************************************************************************)
 <|
     "Description" -> "Resolve single-argument forms of functions with the OneIdentity attribute",
+    "Usage"       -> { Inherited, "Simplification", "Optimization" },
     "Symbols"     :> { Attributes, OneIdentity },
     "Rule"        :>
         (f_Symbol? SymbolQ)[ x: Except[ _Symbol? SymbolQ, _? UAtomQ ] ] /; MemberQ[ Attributes @ f, OneIdentity ] :>
@@ -53,6 +54,7 @@ SetRuleDefaults @ <|
 <|
     (* TODO: this doesn't quite belong in attribute rules *)
     "Description" -> "Resolve Apply when the specified function is not holding",
+    "Usage"       -> { Inherited, "Simplification", "Optimization" },
     "Symbols"     :> { Attributes, HoldFirst, HoldRest, HoldAll, HoldAllComplete, Apply },
     "Rule"        :>
         (f_? SymbolQ) @@ { a___ } /; And[

diff --git a/Data/RuleSets/Internal.wl b/Data/RuleSets/Internal.wl
@@ -23,6 +23,7 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "StripTempHoldWrappers",
     "Description" -> "Strip TempHold wrappers",
     "Symbols"     :> { TempHold },
     "Priority"    -> -Infinity,
@@ -32,6 +33,7 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "PreserveTransformHold",
     "Description" -> "Prevent transformation of TransformHold contents",
     "Symbols"     :> { TransformHold },
     "Priority"    -> -10000,
@@ -41,6 +43,7 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "HandlePacletSymbol",
     "Description" -> "Handle PacletSymbol wrappers for pasted documentation examples",
     "Symbols"     :> { PacletSymbol },
     "Internal"    -> True,
@@ -58,32 +61,17 @@ SetRuleDefaults @ <|
 |>
 
 (**********************************************************************************************************************)
-(* TODO: combine these rules: *)
 <|
+    "Name"        -> "SimplifyTrivialIntegerOperations",
     "Description" -> "Simplify trivial integer operations",
     "Usage"       -> { "EquivalenceTesting", "Optimization", "Simplification" },
-    "Symbols"     :> { Ceiling },
-    "Rule"        :> Ceiling[ i_? IntTypeQ ] :> i
-|>
-
-(**********************************************************************************************************************)
-<|
-    "Description" -> "Simplify trivial integer operations",
-    "Usage"       -> { "EquivalenceTesting", "Optimization", "Simplification" },
-    "Symbols"     :> { Floor },
-    "Rule"        :> Floor[ i_? IntTypeQ ] :> i
-|>
-
-(**********************************************************************************************************************)
-<|
-    "Description" -> "Simplify trivial integer operations",
-    "Usage"       -> { "EquivalenceTesting", "Optimization", "Simplification" },
-    "Symbols"     :> { Round },
-    "Rule"        :> Round[ i_? IntTypeQ ] :> i
+    "Symbols"     :> { Ceiling, Floor, Round, IntegerPart },
+    "Rule"        :> (Ceiling|Floor|Round|IntegerPart)[ i_? IntTypeQ ] :> i
 |>
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "MaskGraphicsIntegerLists",
     "Description" -> "Hide large integer lists in graphics from transformations",
     "Usage"       -> { "EquivalenceTesting", "Optimization" },
     "Symbols"     :> { Graphics, Graphics3D },
@@ -102,6 +90,7 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "FlattenTypedSymbol",
     "Description" -> "Flatten TypedSymbol expressions",
     "Symbols"     :> { TypedSymbol },
     "Internal"    -> True,
@@ -111,6 +100,17 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "ApplyHoldApply",
+    "Description" -> "Apply HoldApply expressions",
+    "Symbols"     :> { HoldApply },
+    "Internal"    -> True,
+    "Priority"    -> 10000,
+    "Rule"        :> HoldApply[ f_, { v___ } ] :> f @ v
+|>
+
+(**********************************************************************************************************************)
+<|
+    "Name"        -> "LoopTest-1",
     "Description" -> "Generate a cycle detection warning for testing",
     "Symbols"     :> { },
     "Internal"    -> True,
@@ -122,6 +122,7 @@ SetRuleDefaults @ <|
 
 (**********************************************************************************************************************)
 <|
+    "Name"        -> "LoopTest-2",
     "Description" -> "Generate a cycle detection warning for testing",
     "Symbols"     :> { },
     "Internal"    -> True,