Museum

VEC_$IADD_MULT_CONSTANT16_I       Domain/OS        VEC_$IADD_MULT_CONSTANT16_I


NAME
     vec_$iadd_mult_constant16_i - add two 16-bit integer vectors, multiply by
     a scalar

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

     void vec_$iadd_mult_constant16_i(
          short int *start_vec,
          long int &start_inc,
          short int *add_vec,
          long int &add_inc,
          long int &length,
          short int &constant,
          short int *result_vec,
          long int &result_inc)

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

     procedure vec_$iadd_mult_constant16_i(
          in start_vec: univ vec_$integer16_vector;
          in start_inc: integer32;
          in add_vec: univ vec_$integer16_vector;
          in add_inc: integer32;
          in length: integer32;
          in constant: integer16;
          out 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), add_vec(nvec), result_vec(nvec), constant
           integer*4 length
           integer*4 start_inc, add_inc, result_inc

           call vec_$iadd_mult_constant16_i(start_vec, start_inc, add_vec, add_inc,
          & length, constant, result_vec, result_inc)

DESCRIPTION
     Vec_$iadd_mult_constant16_i adds its two argument vectors, start_vec and
     add_vec, then multiplies the result by the scalar constant, and stores
     the final result in result_vec.  It differs from vec_$add_mult_constant
     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.

     The calculation performed is as follows:  Initialize the counter vari-
     ables J, K, and L to the low indices of the arrays start_vec, add_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 length times:
     result_vec(L) = (start_vec(J) + add_vec(K)) x constant
     J = J + start_inc
     K = K + add_inc
     L = L + result_inc


     start_vec
          An addend vector.

     start_inc
          The stride for start_vec.

     add_vec
          An addend vector.

     add_inc
          The stride for add_vec.

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

     constant
          The scalar constant by which the result of the addition is multi-
          plied.

     result_vec
          The vector created by adding start_vec and add_vec and multiplying
          the resulting vector by constant.

     result_inc
          The stride for result_vec.

NOTES
     When vec_$iadd_mult_constant16_i is used to operate on matrixes in C and
     Pascal, mult_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 subset of it.   Because of pipelining, using overlapping
     input and output arrays may cause incorrect results.

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

SEE ALSO
     vec_$add_mult_constant, vec_$mult_add_constant, vec_$sub_mult_constant,
     vec_$rsub_mult_constant, vec_$add_mult_constant_i,
     vec_$dadd_mult_constant, vec_$dadd_mult_constant_i,
     vec_$iadd_mult_constant, vec_$iadd_mult_constant_i,
     vec_$iadd_mult_constant16.