1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
.. currentmodule:: tables
Homogenous storage classes
==========================
.. _ArrayClassDescr:
The Array class
---------------
.. autoclass:: Array
Array instance variables
~~~~~~~~~~~~~~~~~~~~~~~~
.. attribute:: Array.atom
An Atom (see :ref:`AtomClassDescr`) instance representing the *type*
and *shape* of the atomic objects to be saved.
.. autoattribute:: Array.rowsize
.. attribute:: Array.nrow
On iterators, this is the index of the current row.
.. autoattribute:: Array.nrows
Array methods
~~~~~~~~~~~~~
.. automethod:: Array.get_enum
.. automethod:: Array.iterrows
.. automethod:: Array.__next__
.. automethod:: Array.read
Array special methods
~~~~~~~~~~~~~~~~~~~~~
The following methods automatically trigger actions when an :class:`Array`
instance is accessed in a special way (e.g. ``array[2:3,...,::2]`` will be
equivalent to a call to
``array.__getitem__((slice(2, 3, None), Ellipsis, slice(None, None, 2))))``.
.. automethod:: Array.__getitem__
.. automethod:: Array.__iter__
.. automethod:: Array.__setitem__
.. _CArrayClassDescr:
The CArray class
----------------
.. autoclass:: CArray
.. _EArrayClassDescr:
The EArray class
----------------
.. autoclass:: EArray
.. _EArrayMethodsDescr:
EArray methods
~~~~~~~~~~~~~~
.. automethod:: EArray.append
.. _VLArrayClassDescr:
The VLArray class
-----------------
.. autoclass:: VLArray
.. These are defined in the class docstring
VLArray instance variables
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoattribute:: VLArray.atom
.. autoattribute:: VLArray.flavor
.. autoattribute:: VLArray.nrow
.. autoattribute:: VLArray.nrows
.. autoattribute:: VLArray.extdim
.. autoattribute:: VLArray.nrows
VLArray properties
~~~~~~~~~~~~~~~~~~
.. autoattribute:: VLArray.size_on_disk
.. autoattribute:: VLArray.size_in_memory
VLArray methods
~~~~~~~~~~~~~~~
.. automethod:: VLArray.append
.. automethod:: VLArray.get_enum
.. automethod:: VLArray.iterrows
.. automethod:: VLArray.__next__
.. automethod:: VLArray.read
.. automethod:: VLArray.get_row_size
VLArray special methods
~~~~~~~~~~~~~~~~~~~~~~~
The following methods automatically trigger actions when a :class:`VLArray`
instance is accessed in a special way (e.g., vlarray[2:5] will be equivalent
to a call to vlarray.__getitem__(slice(2, 5, None)).
.. automethod:: VLArray.__getitem__
.. automethod:: VLArray.__iter__
.. automethod:: VLArray.__setitem__
|
