VariablePattern must be greater than 0

[BinderDavid]

I was writing a simple set of rewrite rules for SKI combinatory logic, but I couldn't get the expressions to simplify.
Here is the code (simplified) that I used:

The definition of CL Terms:

-- | CLF = CombinatoryLogicFunctor
data CLF r = S | K | I | App r r
  deriving (Eq, Ord, Show, Functor, Foldable, Traversable)

type CL = Fix CLF

The rewrite rule for I x ~> x:

-- | I x ~> x
rwi :: Rewrite a CLF
rwi = lhs := rhs
  where
    lhs = NonVariablePattern (App (NonVariablePattern I) (VariablePattern 0))
    rhs = VariablePattern 0

But this rewrite rule will not match, and it took me a while to figure out why: The arguments of VariablePattern have to start with 1, if I replace the rule with the following one:

-- | I x ~> x
rwi :: Rewrite a CLF
rwi = lhs := rhs
  where
    lhs = NonVariablePattern (App (NonVariablePattern I) (VariablePattern 1))
    rhs = VariablePattern 1

Then everything works as expected.

[alt-romes]

Ach! That is very unfortunate.
I think the API to patterns needs to be somewhat improved, possibly hiding these dark corners (if not fixing them).

For VariablePattern my assumption is that people would be using the IsString instance which uses a simple hash function on the string to determine a "unique" number for the VariablePattern. For instance:

-- | I x ~> x
rwi :: Rewrite a CLF
rwi = lhs := rhs
  where
    lhs = pat (App (pat I) "a")
    rhs = "a"

But I still think that is very crude. I think revisiting the API of patterns could be useful soon 👍.

Thanks for reporting. To fix this we ought to do either or all of

• Design a better API that hides this requirement of /= 0
• Or determining why such a requirement is in place ( I vaguely remember this being the case, but I'd have to check )
• Or at the very least document this.

In the meantime I'm keeping this open

[alt-romes]

Accidentally closed while writing the comment. I've edit the response to its final form now.

[BinderDavid]

For VariablePattern my assumption is that people would be using the IsString instance which uses a simple hash function on the string to determine a "unique" number for the VariablePattern

Ah, okay. I wasn't following the tutorial for figuring out how to write patterns, instead I was just following the API and the Haddocks :)

Edit: And now I discovered that there is actually a haddock comment on the VariablePattern constructor which says "Should be a >0 positive number". 🤦