Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libarray.tex @ 19283:b865cd5c1925 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added comments before recently added/assigned slots in the type object, so the backward compatibility issues will be easier to understand. I only added comments indicating additions and assignments back to Python 2.0.
author Fred Drake <fdrake@acm.org>
date Wed, 15 Aug 2001 18:32:33 +0000
parents 2f27838d8fc5
children 376ee174ecd0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
1 \section{\module{array} ---
10647
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
2 Efficient arrays of numeric values}
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
4 \declaremodule{builtin}{array}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
5 \modulesynopsis{Efficient arrays of uniformly typed numeric values.}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
6
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 This module defines a new object type which can efficiently represent
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 an array of basic values: characters, integers, floating point
10647
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
10 numbers. Arrays\index{arrays} are sequence types and behave very much
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
11 like lists, except that the type of objects stored in them is
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
12 constrained. The type is specified at object creation time by using a
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
13 \dfn{type code}, which is a single character. The following type
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
14 codes are defined:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
15
8018
011ae71fea96 Lighten up tables.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
16 \begin{tableiii}{c|l|c}{code}{Type code}{C Type}{Minimum size in bytes}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 \lineiii{'c'}{character}{1}
9618
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
18 \lineiii{'b'}{signed int}{1}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
19 \lineiii{'B'}{unsigned int}{1}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
20 \lineiii{'h'}{signed int}{2}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
21 \lineiii{'H'}{unsigned int}{2}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
22 \lineiii{'i'}{signed int}{2}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
23 \lineiii{'I'}{unsigned int}{2}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
24 \lineiii{'l'}{signed int}{4}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
25 \lineiii{'L'}{unsigned int}{4}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
26 \lineiii{'f'}{float}{4}
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
27 \lineiii{'d'}{double}{8}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 The actual representation of values is determined by the machine
10647
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
31 architecture (strictly speaking, by the C implementation). The actual
9618
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
32 size can be accessed through the \member{itemsize} attribute. The values
4877
e57a8de5aeb3 Added unsigned data formats (B, H, I, L).
Guido van Rossum <guido@python.org>
parents: 2609
diff changeset
33 stored for \code{'L'} and \code{'I'} items will be represented as
e57a8de5aeb3 Added unsigned data formats (B, H, I, L).
Guido van Rossum <guido@python.org>
parents: 2609
diff changeset
34 Python long integers when retrieved, because Python's plain integer
10647
c7470b14dec7 Added "See also" reference to xdrlib.
Fred Drake <fdrake@acm.org>
parents: 9618
diff changeset
35 type cannot represent the full range of C's unsigned (long) integers.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36
2609
7ef72873e4d6 restructured library manual accordiung to functional group
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
37
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
38 The module defines the following function and type object:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
39
7712
0cbc9df882b6 Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents: 7505
diff changeset
40 \begin{funcdesc}{array}{typecode\optional{, initializer}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 Return a new array whose items are restricted by \var{typecode}, and
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
42 initialized from the optional \var{initializer} value, which must be a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 list or a string. The list or string is passed to the new array's
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
44 \method{fromlist()} or \method{fromstring()} method (see below) to add
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
45 initial items to the array.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
47
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
48 \begin{datadesc}{ArrayType}
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
49 Type object corresponding to the objects returned by
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
50 \function{array()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
51 \end{datadesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
52
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
53
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
54 Array objects support the following data items and methods:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
55
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
56 \begin{memberdesc}[array]{typecode}
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
57 The typecode character used to create the array.
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
58 \end{memberdesc}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
59
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
60 \begin{memberdesc}[array]{itemsize}
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
61 The length in bytes of one array item in the internal representation.
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
62 \end{memberdesc}
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
63
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
64
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
65 \begin{methoddesc}[array]{append}{x}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
66 Append a new item with value \var{x} to the end of the array.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
67 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
68
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
69 \begin{methoddesc}[array]{buffer_info}{}
6965
dce838cd42c1 Added missing "\" to "\var{address}, var{length}" in buffer_info() description.
Fred Drake <fdrake@acm.org>
parents: 6875
diff changeset
70 Return a tuple \code{(\var{address}, \var{length})} giving the current
18922
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
71 memory address and the length in elements of the buffer used to hold
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
72 array's contents. The size of the memory buffer in bytes can be
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
73 computed as \code{\var{array}.buffer_info()[1] *
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
74 \var{array}.itemsize}. This is occasionally useful when working with
6022
802470c7a50f Added buffer_info() docs.
Guido van Rossum <guido@python.org>
parents: 5818
diff changeset
75 low-level (and inherently unsafe) I/O interfaces that require memory
18922
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
76 addresses, such as certain \cfunction{ioctl()} operations. The
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
77 returned numbers are valid as long as the array exists and no
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
78 length-changing operations are applied to it.
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
79
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
80 \strong{Note:} When using array objects from code written in C or
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
81 \Cpp{} (the only way to effectively make use of this information), it
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
82 makes more sense to use the buffer interface supported by array
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
83 objects. This method is maintained for backward compatibility and
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
84 should be avoided in new code. The buffer interface is documented in
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
85 the \citetitle[../api/newTypes.html]{Python/C API Reference Manual}.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
86 \end{methoddesc}
6022
802470c7a50f Added buffer_info() docs.
Guido van Rossum <guido@python.org>
parents: 5818
diff changeset
87
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11075
diff changeset
88 \begin{methoddesc}[array]{byteswap}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 ``Byteswap'' all items of the array. This is only supported for
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11075
diff changeset
90 values which are 1, 2, 4, or 8 bytes in size; for other types of
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11075
diff changeset
91 values, \exception{RuntimeError} is raised. It is useful when reading
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11075
diff changeset
92 data from a file written on a machine with a different byte order.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
93 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
94
13772
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
95 \begin{methoddesc}[array]{count}{x}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
96 Return the number of occurences of \var{x} in the array.
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
97 \end{methoddesc}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
98
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
99 \begin{methoddesc}[array]{extend}{a}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
100 Append array items from \var{a} to the end of the array.
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
101 \end{methoddesc}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
102
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
103 \begin{methoddesc}[array]{fromfile}{f, n}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 Read \var{n} items (as machine values) from the file object \var{f}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 and append them to the end of the array. If less than \var{n} items
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
106 are available, \exception{EOFError} is raised, but the items that were
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2491
diff changeset
107 available are still inserted into the array. \var{f} must be a real
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
108 built-in file object; something else with a \method{read()} method won't
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 2491
diff changeset
109 do.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
110 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
111
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
112 \begin{methoddesc}[array]{fromlist}{list}
2491
fb8e08ec88dd changes (suggested) by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
113 Append items from the list. This is equivalent to
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
114 \samp{for x in \var{list}:\ a.append(x)}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
115 except that if there is a type error, the array is unchanged.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
116 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
117
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
118 \begin{methoddesc}[array]{fromstring}{s}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
119 Appends items from the string, interpreting the string as an
18411
eeb2e77c5bad Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents: 15505
diff changeset
120 array of machine values (as if it had been read from a
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
121 file using the \method{fromfile()} method).
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
122 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
123
13772
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
124 \begin{methoddesc}[array]{index}{x}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
125 Return the smallest \var{i} such that \var{i} is the index of
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
126 the first occurence of \var{x} in the array.
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
127 \end{methoddesc}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
128
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
129 \begin{methoddesc}[array]{insert}{i, x}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 Insert a new item with value \var{x} in the array before position
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
131 \var{i}.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
132 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
133
13772
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
134 \begin{methoddesc}[array]{pop}{\optional{i}}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
135 Removes the item with the index \var{i} from the array and returns
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
136 it. The optional argument defaults to \code{-1}, so that by default
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
137 the last item is removed and returned.
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
138 \end{methoddesc}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
139
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
140 \begin{methoddesc}[array]{read}{f, n}
7505
ef980e17b593 Deprecate the read() and write() methods.
Fred Drake <fdrake@acm.org>
parents: 7501
diff changeset
141 \deprecated {1.5.1}
ef980e17b593 Deprecate the read() and write() methods.
Fred Drake <fdrake@acm.org>
parents: 7501
diff changeset
142 {Use the \method{fromfile()} method.}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
143 Read \var{n} items (as machine values) from the file object \var{f}
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
144 and append them to the end of the array. If less than \var{n} items
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
145 are available, \exception{EOFError} is raised, but the items that were
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
146 available are still inserted into the array. \var{f} must be a real
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
147 built-in file object; something else with a \method{read()} method won't
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
148 do.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
149 \end{methoddesc}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
150
13772
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
151 \begin{methoddesc}[array]{remove}{x}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
152 Remove the first occurence of \var{x} from the array.
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
153 \end{methoddesc}
eea51275acbf added count, extend, index, pop and remove to arraymodule
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 12223
diff changeset
154
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
155 \begin{methoddesc}[array]{reverse}{}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
156 Reverse the order of the items in the array.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
157 \end{methoddesc}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
158
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
159 \begin{methoddesc}[array]{tofile}{f}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
160 Write all items (as machine values) to the file object \var{f}.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
161 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
162
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
163 \begin{methoddesc}[array]{tolist}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
164 Convert the array to an ordinary list with the same items.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
165 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
166
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
167 \begin{methoddesc}[array]{tostring}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
168 Convert the array to an array of machine values and return the
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
169 string representation (the same sequence of bytes that would
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
170 be written to a file by the \method{tofile()} method.)
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
171 \end{methoddesc}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
172
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
173 \begin{methoddesc}[array]{write}{f}
7505
ef980e17b593 Deprecate the read() and write() methods.
Fred Drake <fdrake@acm.org>
parents: 7501
diff changeset
174 \deprecated {1.5.1}
ef980e17b593 Deprecate the read() and write() methods.
Fred Drake <fdrake@acm.org>
parents: 7501
diff changeset
175 {Use the \method{tofile()} method.}
7501
d17db3ebfbc2 Updates by AMK.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
176 Write all items (as machine values) to the file object \var{f}.
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
177 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
178
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
179 When an array object is printed or converted to a string, it is
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
180 represented as \code{array(\var{typecode}, \var{initializer})}. The
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
181 \var{initializer} is omitted if the array is empty, otherwise it is a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
182 string if the \var{typecode} is \code{'c'}, otherwise it is a list of
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
183 numbers. The string is guaranteed to be able to be converted back to
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
184 an array with the same type and value using reverse quotes
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 11075
diff changeset
185 (\code{``}), so long as the \function{array()} function has been
18922
2f27838d8fc5 Fix description of buffer_info(), and add a note that there is a better
Fred Drake <fdrake@acm.org>
parents: 18411
diff changeset
186 imported using \code{from array import array}. Examples:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
187
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 6965
diff changeset
188 \begin{verbatim}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
189 array('l')
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
190 array('c', 'hello world')
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
191 array('l', [1, 2, 3, 4, 5])
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
192 array('d', [1.0, 2.0, 3.14])
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 6965
diff changeset
193 \end{verbatim}
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
194
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
195
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
196 \begin{seealso}
15261
bc4f89eefb04 Make all the \seemodule explanations consistent: start with a capitalized
Fred Drake <fdrake@acm.org>
parents: 15256
diff changeset
197 \seemodule{struct}{Packing and unpacking of heterogeneous binary data.}
bc4f89eefb04 Make all the \seemodule explanations consistent: start with a capitalized
Fred Drake <fdrake@acm.org>
parents: 15256
diff changeset
198 \seemodule{xdrlib}{Packing and unpacking of External Data
bc4f89eefb04 Make all the \seemodule explanations consistent: start with a capitalized
Fred Drake <fdrake@acm.org>
parents: 15256
diff changeset
199 Representation (XDR) data as used in some remote
bc4f89eefb04 Make all the \seemodule explanations consistent: start with a capitalized
Fred Drake <fdrake@acm.org>
parents: 15256
diff changeset
200 procedure call systems.}
15505
5e9d0127ace9 Added link to HTML version of the NumPy documentation.
Fred Drake <fdrake@acm.org>
parents: 15261
diff changeset
201 \seetitle[http://numpy.sourceforge.net/numdoc/HTML/numdoc.html]{The
15256
bd4cd73cb0d6 Update the links to the NumPy website and documentation, based on a
Fred Drake <fdrake@acm.org>
parents: 13772
diff changeset
202 Numerical Python Manual}{The Numeric Python extension
bd4cd73cb0d6 Update the links to the NumPy website and documentation, based on a
Fred Drake <fdrake@acm.org>
parents: 13772
diff changeset
203 (NumPy) defines another array type; see
bd4cd73cb0d6 Update the links to the NumPy website and documentation, based on a
Fred Drake <fdrake@acm.org>
parents: 13772
diff changeset
204 \url{http://numpy.sourceforge.net/} for further information
15505
5e9d0127ace9 Added link to HTML version of the NumPy documentation.
Fred Drake <fdrake@acm.org>
parents: 15261
diff changeset
205 about Numerical Python. (A PDF version of the NumPy manual
5e9d0127ace9 Added link to HTML version of the NumPy documentation.
Fred Drake <fdrake@acm.org>
parents: 15261
diff changeset
206 is available at
5e9d0127ace9 Added link to HTML version of the NumPy documentation.
Fred Drake <fdrake@acm.org>
parents: 15261
diff changeset
207 \url{http://numpy.sourceforge.net/numdoc/numdoc.pdf}.}
7804
6d04e8c817fb Use {seealso} environment to refer to the struct module.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
208 \end{seealso}