[MOAB-dev] r2926 - MOAB/trunk/tools/iMesh/python/doc

[jvporter at wisc.edu]

Author: jvporter
Date: 2009-06-03 12:17:40 -0500 (Wed, 03 Jun 2009)
New Revision: 2926

Added:
   MOAB/trunk/tools/iMesh/python/doc/helpers.rst
Log:
Adding missing file from PyTAPS documentation


Added: MOAB/trunk/tools/iMesh/python/doc/helpers.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/helpers.rst	                        (rev 0)
+++ MOAB/trunk/tools/iMesh/python/doc/helpers.rst	2009-06-03 17:17:40 UTC (rev 2926)
@@ -0,0 +1,95 @@
+================
+ PyTAPS Helpers
+================
+
+.. module:: itaps.helpers
+   :synopsis: Helper classes to simplify common operations.
+
+AdjacencyList
+=============
+
+.. class:: AdjacencyList(adj, offsets)
+
+   .. attribute:: adj
+
+      A one-dimensional array of entities adjacent to the queried entities
+
+   .. 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.
+
+      :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.
+
+   .. 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.
+
+      :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.
+
+
+IndexedAdjacencyList
+====================
+
+.. class:: IndexedAdjacencyList(entities, adj, indices, offsets)
+
+   .. attribute:: entities
+
+      A one-dimensional array of entities
+
+   .. attribute:: adj
+
+      A one-dimensional array of all entities adjacent to the elements of
+      ``entities``
+
+   .. attribute:: indices
+
+      An index buffer into ``adj``
+
+   .. attribute:: offsets
+
+      An array of offsets into :attr:`indices` 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.
+
+      :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.
+
+   .. method:: index(i[, j])
+
+      Return the indices of the entities adjacent to the ``i``\ th entity. If
+      ``j`` is specified, returns only the ``j``\ th index of the preceding
+      array.
+
+      :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 index. Otherwise, an array of
+               indices.
+
+   .. 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.
+
+      :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.