Changeset 3320

Timestamp:

11/09/09 17:52:27 (4 months ago)

Author:

jvporter

Message:

* Eliminate unnecessary helpers.OffsetList?.OffsetProxy?
* (Partially) update documentation

Location:

python/trunk

Files:

• doc/helpers.rst (modified) (1 diff)
• doc/igeom.rst (added)
• doc/imesh.rst (modified) (6 diffs)
• doc/index.rst (modified) (2 diffs)
• doc/intro.rst (modified) (1 diff)
• pkg/helpers.py (modified) (2 diffs)
• test/__init__.py (modified) (1 diff)
• test/ibase/__init__.py (added)

python/trunk/doc/helpers.rst

@@ -6 +6 @@
    :synopsis: Helper classes to simplify common operations.
 
-AdjacencyList
+OffsetList
 =============
 
-.. class:: AdjacencyList(adj, offsets)
+.. class:: OffsetList(offsets[, kwargs])
 
-   .. attribute:: adj
+   Return a new OffsetList initialized from an array of offsets and a list of
+   data arrays specified as keyword arguments. An OffsetList is a 
+   multi-dimensional jagged array. The data array is stored as a one-dimensional
+   array which is then indexed into with an array of offsets.
 
-      A one-dimensional array of entities adjacent to the queried entities
+   Passing in a single data array creates an OffsetList that returns scalars
+   when indexing into it; passing in muliple data arrays creates an OffsetList
+   that returns dictionary objects. The supplied names for the data arrays can
+   be used to extract each individual data array. For example::
+
+        o = OffsetList([0,3], x=[1,2,3], y=[4,5,6], z=[7,8,9])
+        o[0]    # returns {'x': [1,2,3], 'y': [4,5,6], 'z': [7,8,9]}
+        o[0, 0] # returns {'x': 1, 'y': 4, 'z': 7}
+        o.x     # returns an OffsetList with only x as a data array
+
+   .. describe:: len(o)
+
+      Return the number of sub-arrays in the object `o`. Equivalent to
+      ``o.length()``.
+
+   .. describe:: o.x
+
+      For an OffsetList `o`, returns a new OffsetList with `x` as its lone data
+      array.      
+
+   .. describe:: o[i]
+   .. describe:: o[i, j]
+
+      Return the array (or dictionary of arrays) for the `i`\ th element of
+      `o`. If `j` is specified, returns only the `j`\ th element of the
+      preceding array (or a dictionary of the `j`\ th elements).
+
+      .. note::
+         If `o` has a single data array named `x`, this method is equivalent to
+         ``o.raw('x')[ o.offsets[i]:o.offsets[i+1] ]`` when
+         only `i` is specified, and is equivalent to
+         ``o.raw('x')[ o.offsets[i]+j ]`` when both `i` and `j` are specified.
+
+      :param i: Outer dimension of the list
+      :param j: Index into the `i`\ th array's sub-array
+      :return: If `o` has only one data array, then: 1) if `j` is specified,
+               a scalar, otherwise 2) an array. If `o` has multiple data
+               arrays, then 1) if `j` is specified, a dictionary of scalars,
+               otherwise 2) a dictionary of arrays.
 
    .. attribute:: offsets
 
-      An array of offsets into :attr:`adj` for each of the queried entities
-
-   .. method:: __getitem__(i[, j])
-
-      Return the entities adjacent to the `i`\ th entity. If `j` is specified,
-      returns only the `j`\ th entity of the preceding array. As you would
-      expect, this is generally called as ``list[i, j]``.
-
-      .. note::
-         This method is equivalent to ``adj[ offsets[i]:offsets[i+1] ]`` when
-         only `i` is specified, and is equivalent to ``adj[ offsets[i]+j ]``
-         when both `i` and `j` are specified.
-
-      :param i: Index of the entity to query for adjacencies
-      :param j: Index into the `i`\ th entity's adjacency array
-      :return: If `j` is specified, a single entity. Otherwise, an array of
-               entities.
+      An array of offsets into the data for each of the queried entities
 
    .. method:: length([i])
 
-      Return the number of entities whose adjacencies are stored in this object.
-      If `i` is specified, return the number of adjacencies for the `i`\ th
-      entity.
+      Return the number of sub-arrays that are stored in this object.
+      If `i` is specified, return the number of elements for the `i`\ th
+      sub-array.
 
-      :param i: Index of the entity to query
-      :return: If `i` is ``None``, the number of entities whose adjacencies
-               are stored. Otherwise, the number of adjacencies for the
-               `i`\ th entity.
+      :param i: Index of the sub-array to query
+      :return: If `i` is ``None``, the number of sub-arrays stored in this
+               object. Otherwise, the number of elements for the `i`\ th
+               sub-array.
+
+   .. method:: raw(name)
+
+      Return the raw (one-dimensional) array for the data array given by `name`.
 
 

python/trunk/doc/imesh.rst

@@ -84 +84 @@
       If ``entities`` is a single entity handle, returns an array of adjacent
       entities. If ``entities`` is an array of entities, return an
-      :class:`~itaps.helpers.AdjacencyList` instance.
+      :class:`~itaps.helpers.OffsetList` instance with a data array named `adj`.
 
       :param entities: Entity or array of entities being queried
       :param typeReq: Type of adjacent entities being requested
       :return: If ``entities`` is a single element, an array of adjacent
-               entities. Otherwise, an :class:`~itaps.helpers.AdjacencyList`
-               instance.
+               entities. Otherwise, an :class:`~itaps.helpers.OffsetList`
+               instance with a data array named `adj`.
 
    .. method:: getEnt2ndAdj(entities, bridgeType, typeReq)
@@ -99 +99 @@
       single entity handle, returns an array of adjacent entities. If 
       ``entities`` is an array of entities, return an
-      :class:`~itaps.helpers.AdjacencyList` instance.
+      :class:`~itaps.helpers.OffsetList` instance with a data array named `adj`.
 
       :param entities: Entity or array of entities being queried
@@ -105 +105 @@
       :param typeReq: Type of adjacent entities being requested
       :return: If ``entities`` is a single element, an array of adjacent
-               entities. Otherwise, an :class:`~itaps.helpers.AdjacencyList`
-               instance.
+               entities. Otherwise, an :class:`~itaps.helpers.OffsetList`
+               instance with a data array named `adj`.
 
    .. method:: createEntSet(isList)
@@ -212 +212 @@
       :return: Array of :class:`Tag`\ s associated with ``entities``
 
-Forwards
---------
+Forwarding
+----------
 
 In addition to the methods listed above, :class:`Mesh` automatically forwards
@@ -237 +237 @@
       Return whether this entity set is ordered.
 
-   .. method:: load(entSet, filename[, options])
+   .. method:: load(filename[, options])
 
       Load a mesh from a file, adding it to this entity set.
@@ -273 +273 @@
       respectively.
 
-      :param entSet: Entity set being queried
       :param type: Type of entities being requested
       :param topo: Topology of entities being requested
-      :return: Array of entity handles from ``entSet`` meeting the requirements
-               of ``type`` and ``topo``.
+      :return: Array of entity handles from this entity set meeting the
+               requirements of ``type`` and ``topo``
 
    .. method:: getAdjEntIndices(type, topo, adjType)

python/trunk/doc/index.rst

@@ -4 +4 @@
 
 PyTAPS is a Python package designed to interface with `ITAPS
-<http://www.tstt-scidac.org/>`_, focusing on the iMesh interface.
+<http://www.tstt-scidac.org/>`_, focusing on support for the Fathom project
+(MOAB and CGM).
 
 .. toctree::
@@ -13 +14 @@
    ibase
    imesh
+   igeom
    helpers

python/trunk/doc/intro.rst

@@ -46 +46 @@
 called is determined by the type of the argument passed to ``add``.
 
-One notable exception to this rule is :meth:`itaps.iMesh.createEnt` and
-:meth:`itaps.iMesh.createEntArr`, which have the same signatures and so cannot
-be overloaded based on the types of the arguments.
+One notable exception to this rule is :meth:`itaps.iMesh.Mesh.createEnt` and
+:meth:`itaps.iMesh.Mesh.createEntArr`, which have the same signatures and so
+cannot be overloaded based on the types of the arguments.
 
 An Example

python/trunk/pkg/helpers.py

@@ -25 +25 @@
         if key not in self._data:
             raise AttributeError
-        return OffsetList.OffsetProxy(self, self._data[key])
+        return OffsetList(self.offsets, **{key: self._data[key]})
 
     def raw(self, key):
@@ -38 +38 @@
     def __len__(self):
         return self.length()
-
-    class OffsetProxy:
-        def __init__(self, parent, data):
-            self.parent = parent
-            self.data = data
-
-        def __getitem__(self, key):
-            return self.parent._get_one(self.data, key)
-
-        def length(self, i = None):
-            return self.parent.length(i)
-
-        def __len__(self):
-            return len(self.parent)
 
 

python/trunk/test/__init__.py

@@ -1 @@
-__all__ = ['igeom', 'imesh']
+__all__ = ['ibase', 'igeom', 'imesh']