18

In a previous question on collecting terms for a multivariable polynomial, I answered with a solution that required a unused symbol to be used for a temporary substitution and back substitution.

It works and everything, but the problem is it depends on the behavior that a symbol is not defined. This is generally a bad idea because a user could have a legitimate use for the symbol we defined. It may even be in the polynomial in question.

This sort of thing can also come up in other contexts, when there may be a need for a temporary symbol. I know I've needed this before and I've often had to think of something random to use.

Is there any way I can get a unique and guaranteed-never-used symbol name for these things?

Community
  • 1
Mike Bailey
  • 1,925
  • 19
  • 32

4 Answers4

21

Unique will do precisely this. Try for example Unique[x], which returns a symbol with a name similar to x$123.

Here I should mention the Temporary attribute as well, which, when associated with a symbol, causes that symbol to be removed from the system when it's no longer referenced. This is occasionally useful when you need Unique.

But whenever you do something like this, the question comes up: why can't you just use localization (Module/Block)?

Szabolcs
  • 234,956
  • 30
  • 623
  • 1,263
  • 2
    +1. As to Module-Block, there are cases when you do need Unique, for example when you want to create some number of unique symbols, and that number is only known at run-time. One situation like that happens when we use dummy symbols to hide certain things from the pattern-matcher, as e.g. here: http://stackoverflow.com/questions/8700934/why-is-cases-so-slow-here-are-there-any-tricks-to-speed-it-up/8701756#8701756 – Leonid Shifrin Jan 18 '12 at 00:45
  • @Szabolcs: The question I linked to gives a case of where you need this. – Mike Bailey Jan 18 '12 at 00:49
  • All good answers, but I'm going to accept this one because you were first and you have some extra explanation w.r.t. some features of Unique. – Mike Bailey Jan 18 '12 at 01:01
13

There is a special-purpose function for this, Unique:

In[270]:= Unique[]
Out[270]= $3

In[271]:= Unique[a]
Out[271]= a$4318

However, these symbols will be guaranteed to be unique only within a given Mathematica session.

Leonid Shifrin
  • 114,335
  • 15
  • 329
  • 420
  • Per session uniqueness is fine for me. That alone is way more than I'd usually need since I create, use, then throw away the symbols all within a Block or Module. – Mike Bailey Jan 18 '12 at 00:42
9

It's not random (uses a counter), but Unique[] will generate a new unused symbol.

Lev Bishop
  • 839
  • 6
  • 12
9

Unique[] is the function that does exactly what you want. However, do note that Unique uses $ModuleNumber and increments it, so if your code depends on the value of $ModuleNumber or if you mess with it, you should be aware of the consequences.

rm -rf
  • 88,781
  • 21
  • 293
  • 472