[Python-checkins] python/dist/src/Doc/lib libsets.tex,1.11,1.12
rhettinger at users.sourceforge.net
rhettinger at users.sourceforge.net
Fri Aug 15 18:56:43 EDT 2003
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv7354
Modified Files:
libsets.tex
Log Message:
Incorporate documentation suggestions from feedback on comp.lang.python.
* Positive wording for the description of why < and > and = can all
be False.
* Move to a three column table format that puts long method names
side-by-side with their operator equivalents
* Mention that KeyError can be raised by Set.pop() and Set.remove().
* Minor tweaks to the examples.
Will backport as soon as Fred rebuilds the docs so I can confirm
the tables formatted properly
Index: libsets.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsets.tex,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** libsets.tex 14 Feb 2003 03:42:11 -0000 1.11
--- libsets.tex 16 Aug 2003 00:56:40 -0000 1.12
***************
*** 66,104 ****
the following operations:
! \begin{tableii}{c|l}{code}{Operation}{Result}
! \lineii{len(\var{s})}{cardinality of set \var{s}}
\hline
! \lineii{\var{x} in \var{s}}
{test \var{x} for membership in \var{s}}
! \lineii{\var{x} not in \var{s}}
{test \var{x} for non-membership in \var{s}}
! \lineii{\var{s}.issubset(\var{t})}
! {test whether every element in \var{s} is in \var{t};
! \code{\var{s} <= \var{t}} is equivalent}
! \lineii{\var{s}.issuperset(\var{t})}
! {test whether every element in \var{t} is in \var{s};
! \code{\var{s} >= \var{t}} is equivalent}
\hline
! \lineii{\var{s} | \var{t}}
! {new set with elements from both \var{s} and \var{t}}
! \lineii{\var{s}.union(\var{t})}
{new set with elements from both \var{s} and \var{t}}
! \lineii{\var{s} \&\ \var{t}}
! {new set with elements common to \var{s} and \var{t}}
! \lineii{\var{s}.intersection(\var{t})}
{new set with elements common to \var{s} and \var{t}}
! \lineii{\var{s} - \var{t}}
! {new set with elements in \var{s} but not in \var{t}}
! \lineii{\var{s}.difference(\var{t})}
{new set with elements in \var{s} but not in \var{t}}
! \lineii{\var{s} \^\ \var{t}}
! {new set with elements in either \var{s} or \var{t} but not both}
! \lineii{\var{s}.symmetric_difference(\var{t})}
{new set with elements in either \var{s} or \var{t} but not both}
! \lineii{\var{s}.copy()}
{new set with a shallow copy of \var{s}}
! \end{tableii}
In addition, both \class{Set} and \class{ImmutableSet}
--- 66,94 ----
the following operations:
! \begin{tableiii}{c|c|l}{code}{Operation}{Equivalent}{Result}
! \lineiii{len(\var{s})}{}{cardinality of set \var{s}}
\hline
! \lineiii{\var{x} in \var{s}}{}
{test \var{x} for membership in \var{s}}
! \lineiii{\var{x} not in \var{s}}{}
{test \var{x} for non-membership in \var{s}}
! \lineiii{\var{s}.issubset(\var{t})}{\code{\var{s} <= \var{t}}}
! {test whether every element in \var{s} is in \var{t}}
! \lineiii{\var{s}.issuperset(\var{t})}{\code{\var{s} >= \var{t}}}
! {test whether every element in \var{t} is in \var{s}}
\hline
! \lineiii{\var{s}.union(\var{t})}{\var{s} | \var{t}}
{new set with elements from both \var{s} and \var{t}}
! \lineiii{\var{s}.intersection(\var{t})}{\var{s} \&\ \var{t}}
{new set with elements common to \var{s} and \var{t}}
! \lineiii{\var{s}.difference(\var{t})}{\var{s} - \var{t}}
{new set with elements in \var{s} but not in \var{t}}
! \lineiii{\var{s}.symmetric_difference(\var{t})}{\var{s} \^\ \var{t}}
{new set with elements in either \var{s} or \var{t} but not both}
! \lineiii{\var{s}.copy()}{}
{new set with a shallow copy of \var{s}}
! \end{tableiii}
In addition, both \class{Set} and \class{ImmutableSet}
***************
*** 113,118 ****
The subset and equality comparisons do not generalize to a complete
ordering function. For example, any two disjoint sets are not equal and
! are not subsets of each other, so \emph{none} of the following are true:
! \code{\var{a}<\var{b}}, \code{\var{a}==\var{b}}, or \code{\var{a}>\var{b}}.
Accordingly, sets do not implement the \method{__cmp__} method.
--- 103,109 ----
The subset and equality comparisons do not generalize to a complete
ordering function. For example, any two disjoint sets are not equal and
! are not subsets of each other, so \emph{all} of the following return
! \code{False}: \code{\var{a}<\var{b}}, \code{\var{a}==\var{b}}, or
! \code{\var{a}>\var{b}}.
Accordingly, sets do not implement the \method{__cmp__} method.
***************
*** 123,127 ****
but not found in \class{Set}:
! \begin{tableii}{c|l|c}{code}{Operation}{Result}
\lineii{hash(\var{s})}{returns a hash value for \var{s}}
\end{tableii}
--- 114,118 ----
but not found in \class{Set}:
! \begin{tableii}{c|l}{code}{Operation}{Result}
\lineii{hash(\var{s})}{returns a hash value for \var{s}}
\end{tableii}
***************
*** 130,167 ****
but not found in \class{ImmutableSet}:
! \begin{tableii}{c|l}{code}{Operation}{Result}
! \lineii{\var{s} |= \var{t}}
! {return set \var{s} with elements added from \var{t}}
! \lineii{\var{s}.union_update(\var{t})}
{return set \var{s} with elements added from \var{t}}
! \lineii{\var{s} \&= \var{t}}
! {return set \var{s} keeping only elements also found in \var{t}}
! \lineii{\var{s}.intersection_update(\var{t})}
{return set \var{s} keeping only elements also found in \var{t}}
! \lineii{\var{s} -= \var{t}}
! {return set \var{s} after removing elements found in \var{t}}
! \lineii{\var{s}.difference_update(\var{t})}
{return set \var{s} after removing elements found in \var{t}}
! \lineii{\var{s} \textasciicircum= \var{t}}
! {return set \var{s} with elements from \var{s} or \var{t}
! but not both}
! \lineii{\var{s}.symmetric_difference_update(\var{t})}
{return set \var{s} with elements from \var{s} or \var{t}
but not both}
\hline
! \lineii{\var{s}.add(\var{x})}
{add element \var{x} to set \var{s}}
! \lineii{\var{s}.remove(\var{x})}
! {remove \var{x} from set \var{s}}
! \lineii{\var{s}.discard(\var{x})}
{removes \var{x} from set \var{s} if present}
! \lineii{\var{s}.pop()}
! {remove and return an arbitrary element from \var{s}}
! \lineii{\var{s}.update(\var{t})}
{add elements from \var{t} to set \var{s}}
! \lineii{\var{s}.clear()}
{remove all elements from set \var{s}}
! \end{tableii}
--- 121,154 ----
but not found in \class{ImmutableSet}:
! \begin{tableiii}{c|c|l}{code}{Operation}{Equivalent}{Result}
! \lineiii{\var{s}.union_update(\var{t})}
! {\var{s} |= \var{t}}
{return set \var{s} with elements added from \var{t}}
! \lineiii{\var{s}.intersection_update(\var{t})}
! {\var{s} \&= \var{t}}
{return set \var{s} keeping only elements also found in \var{t}}
! \lineiii{\var{s}.difference_update(\var{t})}
! {\var{s} -= \var{t}}
{return set \var{s} after removing elements found in \var{t}}
! \lineiii{\var{s}.symmetric_difference_update(\var{t})}
! {\var{s} \textasciicircum= \var{t}}
{return set \var{s} with elements from \var{s} or \var{t}
but not both}
\hline
! \lineiii{\var{s}.add(\var{x})}{}
{add element \var{x} to set \var{s}}
! \lineiii{\var{s}.remove(\var{x})}{}
! {remove \var{x} from set \var{s}; raises KeyError if not present}
! \lineiii{\var{s}.discard(\var{x})}{}
{removes \var{x} from set \var{s} if present}
! \lineiii{\var{s}.pop()}{}
! {remove and return an arbitrary element from \var{s}; raises
! KeyError if empty}
! \lineiii{\var{s}.update(\var{t})}{}
{add elements from \var{t} to set \var{s}}
! \lineiii{\var{s}.clear()}{}
{remove all elements from set \var{s}}
! \end{tableiii}
***************
*** 172,180 ****
>>> engineers = Set(['John', 'Jane', 'Jack', 'Janice'])
>>> programmers = Set(['Jack', 'Sam', 'Susan', 'Janice'])
! >>> management = Set(['Jane', 'Jack', 'Susan', 'Zack'])
! >>> employees = engineers | programmers | management # union
! >>> engineering_management = engineers & programmers # intersection
! >>> fulltime_management = management - engineers - programmers # difference
! >>> engineers.add('Marvin') # add element
>>> print engineers
Set(['Jane', 'Marvin', 'Janice', 'John', 'Jack'])
--- 159,167 ----
>>> engineers = Set(['John', 'Jane', 'Jack', 'Janice'])
>>> programmers = Set(['Jack', 'Sam', 'Susan', 'Janice'])
! >>> managers = Set(['Jane', 'Jack', 'Susan', 'Zack'])
! >>> employees = engineers | programmers | managers # union
! >>> engineering_management = engineers & managers # intersection
! >>> fulltime_management = managers - engineers - programmers # difference
! >>> engineers.add('Marvin') # add element
>>> print engineers
Set(['Jane', 'Marvin', 'Janice', 'John', 'Jack'])
More information about the Python-checkins
mailing list