Museum

VEC_$IREC1N16_I                   Domain/OS                    VEC_$IREC1N16_I


NAME
     vec_$irec1n16_i - calculate first-order linear recurrence of 16-bit
     integer vector with coefficient 1

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

     void vec_$irec1n16_i(
          short int *start_vec,
          long int &start_inc,
          long int &count,
          short int *result_vec,
          long int &result_inc)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/vec.ins.pas';
     procedure vec_$irec1n16_i(
          in start_vec: univ vec_$integer16_vector;
          in start_inc: integer32;
          in count: integer32;
          var result_vec: univ vec_$integer16_vector;
          in result_inc: integer32);

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

           parameter (nvec = 10)

           integer*2 start_vec(nvec), result_vec(nvec)
           integer*4 count
           integer*4 start_inc, result_inc

           call vec_$irec1n16_i(start_vec, start_inc, count, result_vec, result_inc)

DESCRIPTION
     Vec_$irec1n16_i calculates a first-order linear recurrence with coeffi-
     cient 1 based on start_vec.  It differs from vec_$rec1n_i in that the
     vectors being handled contain 16-bit integers.

     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.

     This routine reads the first entry in the array result_vec; it then
     writes count entries into result_vec based on the following formula:

     Initialize the counter variables J and K to the low indices of the arrays
     start_vec and result_vec.  In Fortran, the low index will be 1;  in C, it
     will be 0; in Pascal, it varies depending on the declaration.
     Execute the following equations count times:
     result_vec(K+1) = start_vec(J) + result_vec(K)
     J = J + start_inc
     K = K + result_inc

     Notice that result_vec is used both for input and output, and that it
     must be large enough to hold count + 1 entries.

     start_vec
          An input vector.

     start_inc
          The stride for start_vec.

     count
          The number of elements to be operated on.

     result_vec
          The vector containing one input value and the result of the
          recurrence calculation.

     result_inc
          The stride for result_vec.

NOTES
     When vec_$irec1n16_i is used to operate on matrixes in C and Pascal,
     start_vec  and result_vec are row vectors; in FORTRAN, they are column
     vectors.

     As in all the vec_$ calls,  the result array must not overlap any of the
     input arrays; the result array may be identical to an input, but must not
     contain any smaller subset of an input.   Because of pipelining, using
     overlapping input and output arrays may cause incorrect results.

     Vec_$irec1n16_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_$rec1, vec_$rec1c, vec_$rec1r, vec_$rec1cr, vec_$rec1n, vec_$rec1n_i,
     vec_$drec1n, vec_$drec1n_i, vec_$irec1n, vec_$irec1n_i, vec_$irec1n16.