VEC_$SUB_VECTOR                   Domain/OS                    VEC_$SUB_VECTOR


NAME
     vec_$sub_vector - subtract two single-precision vectors

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

     void vec_$sub_vector(
          float *start_vec,
          float *sub_vec,
          long int &length,
          float *result_vec)

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

     procedure vec_$sub_vector(
          in start_vec: univ vec_$real_vector;
          in sub_vec: univ vec_$real_vector;
          in length: integer32;
          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), result_vec(nvec), sub_vec(nvec)
           integer*4 length

           call vec_$sub_vector(start_vec, sub_vec, length, result_vec)

DESCRIPTION
     Vec_$sub_vector subtracts the vector sub_vec from start_vec 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) = start_vec(I) - sub_vec(I)

     start_vec
          A vector to be subtracted from.

     sub_vec
          A vector to be subtracted.

     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.

NOTES
     When vec_$sub_vector is used to operate on matrixes in C and Pascal,
     start_vec, sub_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_vector, vec_$mult_vector, vec_$sub_vector_i, vec_$dsub_vector,
     vec_$dsub_vector_i, vec_$isub_vector, vec_$isub_vector_i,
     vec_$isub_vector16, vec_$isub_vector16_i.