next up previous contents
Next: Minloc Up: MaxlocDim Previous: MaxlocDim   Contents

Effect and Restrictions

Effect:
On exit, the value of


  res [
$ x_0, \ldots , x_{\mbox{\tt dim-1}}, x_{\mbox{\tt dim+1}}, \ldots , x_{R - 1}$]
is the maximum value of


  source [
$ x_0, \ldots, x_{\mbox{\tt dim-1}}, x_{\mbox{\tt dim}},
 x_{\mbox{\tt dim+1}}, \ldots, x_{R - 1}$]
for which

   mask [$\displaystyle x_0, \ldots,
x_{\mbox{\tt dim-1}}, x_{\mbox{\tt dim}}, x_{\mbox{\tt dim+1}},
\ldots, x_{R - 1} \mbox{\tt ]} \neq false
$

over the allowed values of $ x_{\mbox{\tt dim}}$. The value of


  loc [
$ x_0, \ldots , x_{\mbox{\tt dim-1}}, x_{\mbox{\tt dim+1}}, \ldots , x_{R - 1}$]
is the smallest $ x_{\mbox{\tt dim}}$ value at which this maximum occurs. It has same effect as without the mask if all values of the mask are true. If all elements of the mask are false, res will store most negative value in its type and loc will store most positive value in its type. As implied by the replicated alignment of the result array, results are broadcast in the process dimension associated with dimension dim of the source array.
Value restrictions:
The value of dimension must be in the range 0, ...,$ R$-1 where $ R$ is the rank of the source array.
Shape restrictions:
The shape of the two result arrays (res and loc) must be obtained from the shape of the source array by deleting dimension dimension. The mask array if present must be same shape as the source array.
Alignment restrictions:
The two result arrays (res and loc) must be aligned to the source array, with replicated alignment in dimension dimension. The mask array if present must be aligned with the source array.
Containment restrictions:
The source array and mask array if present and the result array must be fully contained in the active progess group.
Overlap restrictions:
In-place updates are not allowed.
Replicated data:
If the source array or mask array if present has replicated mapping, values for particular elements are generally taken from the nearest copy. The definition of ``nearest'' is implementation dependent. Consistent replication of copies in the result array relies on consistency of copies in the source array.

next up previous contents
Next: Minloc Up: MaxlocDim Previous: MaxlocDim   Contents
Bryan Carpenter 2004-06-09