vec_dsub_constant()

VEC_$DSUB_CONSTANT                Domain/OS                 VEC_$DSUB_CONSTANT


NAME
     vec_$dsub_constant - subtract a double-precision vector from a scalar

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

     void vec_$dsub_constant(
          double *start_vec,
          long int &length,
          double &constant,
          double *result_vec)

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

     procedure vec_$dsub_constant(
          in start_vec: univ vec_$double_vector;
          in length: integer32;
          in constant: double;
          out result_vec: univ vec_$double_vector);

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

           parameter (nvec = 10)

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

           call vec_$dsub_constant(start_vec, length, constant, result_vec)

DESCRIPTION
     Vec_$dsub_constant subtracts the vector start_vec from the scalar con-
     stant and stores the final result in result_vec.  The calculation per-
     formed is as follows:

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

     start_vec
          The vector to be subtracted from constant.

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

     constant
          The scalar from which start_vec is subtracted.

     result_vec
          The vector created by subtracting start_vec from constant.

NOTES
     When vec_$dsub_constant 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 subset of it.   Because of pipelining, using overlapping
     input and output arrays may cause incorrect results.


SEE ALSO
     vec_$add_constant, vec_$mult_constant, vec_$sub_constant_i,
     vec_$sub_constant, vec_$dsub_constant_i, vec_$isub_constant,
     vec_$isub_constant_i, vec_$isub_constant16, vec_$isub_constant16_i.
Museum
