vec_mult_sub()

VEC_$MULT_SUB                     Domain/OS                      VEC_$MULT_SUB


NAME
     vec_$mult_sub - multiply a scalar by a single-precision vector, subtract
     a vector

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

     void vec_$mult_sub(
          float *mult_vec,
          float *start_vec,
          long int &length,
          float &constant,
          float *result_vec)

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

     procedure vec_$mult_sub(
          in mult_vec: univ vec_$real_vector;
          in start_vec: univ vec_$real_vector;
          in length: integer32;
          in constant: real;
          out result_vec: univ vec_$real_vector);

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

           parameter (nvec = 10)

           real start_vec(nvec), mult_vec(nvec), result_vec(nvec), constant
           integer*4 length

           call vec_$mult_sub(mult_vec, start_vec, length, constant, result_vec)

DESCRIPTION
     Vec_$mult_sub multiplies the vector mult_vec by the scalar constant, sub-
     tracts the vector start_vec from the result, and stores the final result
     in result_vec.  The calculation performed is as follows:

     For each integer I such that 1 <= I <= length,
     result_vec(I) = (constant x mult_vec(I))-start_vec(I)

     mult_vec
          The vector to be multiplied.

     start_vec
          The vector to be subtracted.

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

     constant
          The scalar by which mult_vec is multiplied.

     result_vec
          The vector created by multiplying mult_vec by constant and subtract-
          ing  start_vec from the result.

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


SEE ALSO
     vec_$add_mult, vec_$sub_mult, vec_$mult_add, vec_$mult_sub_i,
     vec_$dmult_sub, vec_$dmult_sub_i, vec_$imult_sub, vec_$imult_sub_i,
     vec_$imult_sub16, vec_$imult_sub16_i.
Museum
