.. default-domain:: chpl

.. module:: BlockCycDim

BlockCycDim
===========
**Usage**

.. code-block:: chapel

   use BlockCycDim;


or

.. code-block:: chapel

   import BlockCycDim;
.. record:: BlockCyclicDim

   
   This Block-Cyclic dimension specifier is for use with the
   :mod:`dimensionalDist2D <DimensionalDist2D>` distribution.
   
   It specifies the mapping of indices in its dimension
   that would be produced by a 1D :class:`~BlockCycDist.blockCycDist` distribution.
   
   **Initializer Arguments**
   
   The ``BlockCyclicDim`` record initializer is defined as follows:
   
     .. code-block:: chapel
   
       proc init(
         numLocales:   int,
         lowIdx:       int,
         blockSize:    int,
         cycleSizePos: int = // computed by the implementation )
   
   The arguments are as follows:
   
     ``numLocales``
         the number of locales that this dimension's indices are
         to be distributed over
     ``lowIdx``, ``blockSize``
         are the counterparts to ``startIdx`` and ``blocksize``
         in the :class:`~BlockCycDist.blockCycDist` distribution
     ``cycleSizePos``
         is used internally by the implementation and
         should not be specified by the user code