Skip to content

Commit

Permalink
Changed 'start' to 'begin'
Browse files Browse the repository at this point in the history
  • Loading branch information
ldh4 committed Jul 30, 2024
1 parent 07a8176 commit 6cd5e99
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/source/API/core/policies/RangePolicy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,26 +122,26 @@ Constructors

.. cppkokkos:function:: RangePolicy(IndexType begin, IndexType end)
Provide a start and end index.
Provide a begin and end index.

.. cppkokkos:function:: RangePolicy(IndexType begin, IndexType end, ChunkSize chunk_size)
Provide a start and end index as well as a ``ChunkSize``.
Provide a begin and end index as well as a ``ChunkSize``.

.. cppkokkos:function:: RangePolicy(const ExecutionSpace& space, IndexType begin, IndexType end)
Provide a start and end index and an ``ExecutionSpace`` instance to use as the execution resource.
Provide a begin and end index and an ``ExecutionSpace`` instance to use as the execution resource.

.. cppkokkos:function:: RangePolicy(const ExecutionSpace& space, IndexType begin, IndexType end, ChunkSize chunk_size)
Provide a start and end index and an ``ExecutionSpace`` instance to use as the execution resource, as well as a ``ChunkSize``.
Provide a begin and end index and an ``ExecutionSpace`` instance to use as the execution resource, as well as a ``ChunkSize``.

Preconditions:
^^^^^^^^^^^^^^

* The start index must not be greater than the end index.
* The begin index must not be greater than the end index.
* The actual constructors are templated so we can check that they are converted to ``index_type`` safely (see `#6754 <https://github.com/kokkos/kokkos/pull/6754>`_).
* The conversion safety check is only performed if ``index_type`` is convertible to the start and end index types.
* The conversion safety check is only performed if ``index_type`` is convertible to the begin and end index types.

CTAD Constructors (since 4.3):
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 6cd5e99

Please sign in to comment.