MATHEMATICA TUTORIAL

Flat and Orderless Functions

Although Mathematica matches patterns in a purely structural fashion, its notion of structural equivalence is quite sophisticated. In particular, it takes account of properties such as commutativity and associativity in functions like Plus and Times.

This means, for example, that Mathematica considers the expressions

and

equivalent for the purposes of pattern matching. As a result, a pattern like

can match not only

, but also

This expression has exactly the same form as the pattern.

In[1]:=

Out[1]=

In this case, the expression has to be put in the form

in order to have the same structure as the pattern.

In[2]:=

Out[2]=

Whenever Mathematica encounters an orderless or commutative function such as Plus or Times in a pattern, it effectively tests all the possible orders of arguments to try and find a match. Sometimes, there may be several orderings that lead to matches. In such cases, Mathematica just uses the first ordering it finds. For example,

could match

with

or with

. Mathematica tries the case

first, and so uses this match.

This can match either with

or with

. Mathematica tries

first, and so uses this match.

In[3]:=

Out[3]=

ReplaceList shows both possible matches.

In[4]:=

Out[4]=

As discussed in "Attributes", Mathematica allows you to assign certain attributes to functions, which specify how those functions should be treated in evaluation and pattern matching. Functions can for example be assigned the attribute Orderless, which specifies that they should be treated as commutative or symmetric, and allows their arguments to be rearranged in trying to match patterns.

Orderless	commutative function: , etc., are equivalent to
Flat	associative function: , etc., are equivalent to
OneIdentity	, etc., are equivalent to a
Attributes[f]	give the attributes assigned to f
SetAttributes[f,attr]	add attr to the attributes of f
ClearAttributes[f,attr]	remove attr from the attributes of f

Some attributes that can be assigned to functions.

Plus has attributes Orderless and Flat, as well as others.

In[5]:=

Out[5]=

This defines

to be an orderless or commutative function.

In[6]:=

The arguments of

are automatically sorted into order.

In[7]:=

Out[7]=

Mathematica rearranges the arguments of

functions to find a match.

In[8]:=

Out[8]=

In addition to being orderless, functions like Plus and Times also have the property of being flat or associative. This means that you can effectively "parenthesize" their arguments in any way, so that, for example,

is equivalent to

, and so on.

Mathematica takes account of flatness in matching patterns. As a result, a pattern like

can match

, with

and

The argument of

is written as

so as to match the pattern.

In[9]:=

Out[9]=

If there are no other constraints, Mathematica will match

to the first element of the sum.

In[10]:=

Out[10]=

This shows all the possible matches.

In[11]:=

Out[11]=

Here

is forced to match

In[12]:=

Out[12]=

Mathematica can usually apply a transformation rule to a function only if the pattern in the rule covers all the arguments in the function. However, if you have a flat function, it is sometimes possible to apply transformation rules even though not all the arguments are covered.

This rule applies even though it does not cover all the terms in the sum.

In[13]:=

Out[13]=

This combines two of the terms in the sum.

In[14]:=

Out[14]=

Functions like Plus and Times are both flat and orderless. There are, however, some functions, such as Dot, which are flat, but not orderless.

Both

and

can match any sequence of terms in the dot product.

In[15]:=

Out[15]=

This assigns the attribute Flat to the function

In[16]:=

Mathematica writes the expression in the form

to match the pattern.

In[17]:=

Out[17]=

Mathematica writes this expression in the form

to match the pattern.

In[18]:=

Out[18]=

In an ordinary function that is not flat, a pattern such as

matches an individual argument of the function. But in a function

that is flat,

can match objects such as

which effectively correspond to a sequence of arguments. However, in the case where

matches a single argument in a flat function, the question comes up as to whether the object it matches is really just the argument a itself, or

. Mathematica chooses the first of these cases if the function carries the attribute OneIdentity, and chooses the second case otherwise.

This adds the attribute OneIdentity to the function

In[19]:=

Now

matches individual arguments, without

wrapped around them.

In[20]:=

Out[20]=

The functions Plus, Times, and Dot all have the attribute OneIdentity, reflecting the fact that Plus[x] is equivalent to x, and so on. However, in representing mathematical objects, it is often convenient to deal with flat functions that do not have the attribute OneIdentity.