Skip to content

Commit

Permalink
Bug #1565919: document set types in the Language Reference.
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.python.org/projects/python/trunk@52297 6015fed2-1504-0410-9fe1-9d1591cc4771
  • Loading branch information
georg.brandl committed Oct 12, 2006
1 parent fb950b8 commit a0ae945
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
35 changes: 35 additions & 0 deletions Doc/ref/ref3.tex
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,41 @@ \section{The standard type hierarchy\label{types}}

\end{description} % Sequences


\item[Set types]
These represent unordered, finite sets of unique, immutable objects.
As such, they cannot be indexed by any subscript. However, they can be
iterated over, and the built-in function \function{len()} returns the
number of items in a set. Common uses for sets are
fast membership testing, removing duplicates from a sequence, and
computing mathematical operations such as intersection, union, difference,
and symmetric difference.
\bifuncindex{len}
\obindex{set type}

For set elements, the same immutability rules apply as for dictionary
keys. Note that numeric types obey the normal rules for numeric
comparison: if two numbers compare equal (e.g., \code{1} and
\code{1.0}), only one of them can be contained in a set.

There are currently two intrinsic set types:

\begin{description}

\item[Sets]
These\obindex{set} represent a mutable set. They are created by the
built-in \function{set()} constructor and can be modified afterwards
by several methods, such as \method{add()}.

\item[Frozen sets]
These\obindex{frozenset} represent an immutable set. They are created by
the built-in \function{frozenset()} constructor. As a frozenset is
immutable and hashable, it can be used again as an element of another set,
or as a dictionary key.

\end{description} % Set types


\item[Mappings]
These represent finite sets of objects indexed by arbitrary index sets.
The subscript notation \code{a[k]} selects the item indexed
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,8 @@ Tests
Documentation
-------------

- Bug #1565919: document set types in the Language Reference.

- Bug #1546052: clarify that PyString_FromString(AndSize) copies the
string pointed to by its parameter.

Expand Down

0 comments on commit a0ae945

Please sign in to comment.