Museum

VEC_$SUB_MULT_VECTOR_I            Domain/OS             VEC_$SUB_MULT_VECTOR_I


NAME
     vec_$sub_mult_vector_i - subtract two single-precision vectors, multiply
     by a third

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

     void vec_$sub_mult_vector_i(
          float *start_vec,
          long int &start_inc,
          float *sub_vec,
          long int &sub_inc,
          float *mult_vec,
          long int &mult_inc,
          long int &length,
          float *result_vec,
          long int &result_inc)

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

     procedure vec_$sub_mult_vector_i(
          in start_vec: univ vec_$real_vector;
          in start_inc: integer32;
          in sub_vec: univ vec_$real_vector;
          in sub_inc: integer32;
          in mult_vec: univ vec_$real_vector;
          in mult_inc: integer32;
          in length: integer32;
          out result_vec: univ vec_$real_vector;
          in result_inc: integer32);

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

           parameter (nvec = 10)

           real start_vec(nvec), result_vec(nvec), sub_vec(nvec), mult_vec(nvec)
           integer*4 length
           integer*4 start_inc, sub_inc, mult_inc, result_inc

           call vec_$sub_mult_vector_i(start_vec, start_inc, sub_vec, sub_inc,
          & mult_vec, mult_inc, length, result_vec, result_inc)

DESCRIPTION
     Vec_$sub_mult_vector_i subtracts the vector sub_vec from start_vec, mul-
     tiplies the result by mult_vec, and stores the final result in
     result_vec.

     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, L, and M to the low indices of the arrays start_vec, sub_vec,
     mult_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(M) = (start_vec(J) - sub_vec(K)) x mult_vec(L)
     J = J + start_inc
     K = K + sub_inc
     L = L + mult_inc
     M = M + result_inc


     Note that the multiplication done by this call is point-wise.  This call
     does not perform matrix multiplication, since the product of two vectors
     is another vector of the same magnitude.

     start_vec
          A vector to be subtracted from.

     start_inc
          The stride for start_vec.

     sub_vec
          A vector to be subtracted.

     sub_inc
          The stride for sub_vec.

     mult_vec
          A multiplicand vector.

     mult_inc
          The stride for mult_vec.

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

     result_vec
          The vector created by subtracting sub_vec from start_vec and multi-
          plying the result by mult_vec.

     result_inc
          The stride for result_vec.

NOTES
     When vec_$sub_mult_vector_i is used to operate on matrixes in C and Pas-
     cal, start_vec, sub_vec, 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.


SEE ALSO
     vec_$add_mult_vector, vec_$mult_add_vector, vec_$mult_sub_vector,
     vec_$mult_rsub_vector, vec_$add_add_vector, vec_$sub_add_vector,
     vec_$mult_mult_vector, vec_$sub_mult_vector, vec_$dsub_mult_vector,
     vec_$dsub_mult_vector_i, vec_$isub_mult_vector, vec_$isub_mult_vector_i,
     vec_$isub_mult_vector16, vec_$isub_mult_vector16_i.