Skip to content

Commit

Permalink
devdocs: add missing Bool argument for bounds checking [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
timholy committed Jul 13, 2016
1 parent 511fc89 commit bd812bd
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/devdocs/boundscheck.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ The overall hierarchy is:

| ``checkbounds(A, I...)`` which calls
| ``checkbounds(Bool, A, I...)`` which calls either of:
| ``checkbounds_logical(A, I)`` when ``I`` is a single logical array
| ``checkbounds_indices(indices(A), I)`` otherwise
| ``checkbounds_logical(Bool, A, I)`` when ``I`` is a single logical array
| ``checkbounds_indices(Bool, indices(A), I)`` otherwise
|
Here ``A`` is the array, and ``I`` contains the "requested" indices.
Expand All @@ -85,8 +85,8 @@ dimensions handled by calling another important function,
``checkindex``: typically,
::

checkbounds_indices((IA1, IA...), (I1, I...)) = checkindex(Bool, IA1, I1) &
checkbounds_indices(IA, I)
checkbounds_indices(Bool, (IA1, IA...), (I1, I...)) = checkindex(Bool, IA1, I1) &
checkbounds_indices(Bool, IA, I)

so ``checkindex`` checks a single dimension. All of these functions,
including the unexported ``checkbounds_indices`` and
Expand Down

0 comments on commit bd812bd

Please sign in to comment.