What is the purpose of MatchLocalNameQ?

Question

I found a kernel function which is undocument MatchLocalNameQ.But I don't know the purpose of it.

a = 1;
b = 1;
MatchLocalNameQ[a, b]

False

a = 1;
b = 1;
MatchLocalNameQ[a, a]

True

But what want to do really this function?It's useful to us?

considering its name I'd expect it to check whether something is a local variable like in MatchLocalNameQ[Evaluate@Module[{a},a],a] which gives True. The second seems to be a "template" for which the local variable has been generated. — Albert Retey, Commented Dec 18, 2016 at 16:51
I think it's closely connected to MatchLocalNames, which gives a bit of a hint. — corey979, Commented Dec 18, 2016 at 16:56
@corey979 Thanks,that is a reasonable guess(ping QuantumDot,too) — yode, Commented Dec 18, 2016 at 16:58

Szabolcs · Accepted Answer · 2016-12-18 17:11:38Z

8

It checks whether the first argument is a Module-localized version of the second:

MatchLocalNameQ[x$1, x]
(* True *)

Module localizes like this:

Module[{x}, x]
(* x$29141 *)

answered Dec 18, 2016 at 17:11

Szabolcs

236k31 gold badges641 silver badges1.3k bronze badges

Add a comment |

1 Answer 1