VEC_$IRMAX16_I                    Domain/OS                     VEC_$IRMAX16_I


NAME
     vec_$irmax16_i - find the maximum value in a 16-bit integer vector

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/vec.h>

     long int vec_$irmax16_i(
          short int *start_vec,
          long int &start_inc,
          long int &length,
          short int *result)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/vec.ins.pas';

     function vec_$irmax16_i(
          in start_vec: univ vec_$integer16_vector;
          in start_inc: integer32;
          in length: integer32;
          out result: integer16): integer32;

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/vec.ins.ftn'

           parameter (nvec = 10)

           integer*2 start_vec(nvec), result
           integer*4 length, location
           integer*4 start_inc

           location = vec_$irmax16_i(start_vec, start_inc, length, result)

DESCRIPTION
     Vec_$irmax16_i searches through length elements of start_vec, sets loca-
     tion to the greatest element, and returns the location of the element
     with the greatest value. By contrast, vec_$iamax16_i finds the element
     with greatest absolute value.  vec_$irmax16_i differs from vec_$imax16_i
     in being a function instead of a procedure; vec_$imax16_i is now
     obsolete.

     In the case of a tie, vec_$irmax16_i returns the index of the first max-
     imum value found.

     This call, like all vec_$ calls ending in _i, takes a set of extra stride
     arguments, one for every vector argument.  The stride arguments determine
     which elements in the array are actually processed.  For instance, if the
     stride for a particular array is set to 3, every third element in the
     array will be processed by the routine.  The stride arguments need not be
     identical.  If all stride arguments are set to 1, this call behaves
     exactly like the version without the _i in its name.  If the argument
     start_inc is not set to 1, the returned index is relative to the stride;
     it does not necessarily correspond to the actual vector index.  For exam-
     ple, if start_inc is set to 5, and the third element examined is the
     largest, this routine will return 3, even though the actual index of the
     largest element is 11.


     start_vec
          The vector to be searched.

     start_inc
          The stride for start_vec.

     length
          The number of elements to be operated on;  normally the same as the
          number of elements in the vectors.

     result
          The value of the greatest element in start_vec.

NOTES
     In C and Pascal, vec_$irmax16_i searches a row vector; in FORTRAN, it
     searches a column vector.

     Vec_$irmax16_i, like all 16-bit integer routines, performs poorly when
     compared to the 32-bit integer routines.  Its use should be avoided wher-
     ever possible, especially on high-performance workstations.

SEE ALSO
     vec_$rmin, vec_$amax, vec_$amin, vec_$rmax_i, vec_$drmax, vec_$drmax_i,
     vec_$rmax, vec_$irmax_i, vec_$rmax, vec_$irmax16.