VEC_$RMIN_I Domain/OS VEC_$RMIN_I
NAME
vec_$rmin_i - find the minimum value in a single-precision vector
SYNOPSIS (C)
#include <apollo/base.h>
#include <apollo/vec.h>
long int vec_$rmin_i(
float *start_vec,
long int &start_inc,
long int &length,
float *result)
SYNOPSIS (Pascal)
%include '/sys/ins/base.ins.pas';
%include '/sys/ins/vec.ins.pas';
function vec_$rmin_i(
in start_vec: univ vec_$real_vector;
in start_inc: integer32;
in length: integer32;
out result: real): integer32;
SYNOPSIS (FORTRAN)
%include '/sys/ins/base.ins.ftn'
%include '/sys/ins/vec.ins.ftn'
parameter (nvec = 10)
real start_vec(nvec), result
integer*4 length, location
integer*4 start_inc
location = vec_$rmin_i(start_vec, start_inc, length, result)
DESCRIPTION
Vec_$rmin_i searches through length elements of start_vec, sets result to
the smallest value in the vector, and returns the location of the element
with the smallest value. By contrast, vec_$amin_i finds the element with
smallest absolute value. In the case of a tie, vec_$rmin_i returns the
index of the first minimum 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 example, if start_inc is set to 5, and the third element
examined is the smallest, this routine will return 3, even though the
actual index of the smallest 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 smallest element in start_vec.
NOTES
In C and Pascal, vec_$rmin_i searches a row vector; in FORTRAN, it
searches a column vector.
SEE ALSO
vec_$rmax, vec_$amax, vec_$amin, vec_$rmin, vec_$drmin, vec_$drmin_i,
vec_$irmin, vec_$irmin_i, vec_$irmin16, vec_$irmin16_i.