Procedure

     SUMAI ( Sum of an integer array )

     INTEGER FUNCTION SUMAI ( ARRAY, N )

Abstract

     Return the sum of the elements of an integer array.

Required_Reading

     None.

Keywords

     ARRAY
     MATH
     UTILITY

Declarations

     IMPLICIT NONE

     INTEGER          ARRAY  ( * )
     INTEGER          N

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     ARRAY      I   Input array.
     N          I   Number of elements in ARRAY.

     The function returns the sum of the elements of ARRAY.

Detailed_Input

     ARRAY    is the input integer array.

     N        is the number of elements in the array.

Detailed_Output

     The function returns the sum of the elements of the input array.
     That is,

        SUMAI( ARRAY, N ) = ARRAY(1) + ARRAY(2) + ... + ARRAY(N)

     If N is zero or negative, SUMAI is zero.

Parameters

     None.

Exceptions

     Error free.

Files

     None.

Particulars

     The value of the function is initially set to zero. The elements
     of the array are then added. If the number of elements is zero or
     negative, SUMAI is zero.

Examples

     Let ARRAY contain the following elements.

           ARRAY(1) = 12
           ARRAY(2) =  1
           ARRAY(3) =  4
           ARRAY(4) = 75
           ARRAY(5) = 18

     Then

           SUMAI ( ARRAY,   -3 )       =   0
           SUMAI ( ARRAY,    0 )       =   0
           SUMAI ( ARRAY,    1 )       =  12
           SUMAI ( ARRAY,    2 )       =  13
           SUMAI ( ARRAY,    5 )       = 110
           SUMAI ( ARRAY(3), 3 )       =  97

Restrictions

     1)  SUMAI does not check for overflow.

Literature_References

     None.

Author_and_Institution

     J. Diaz del Rio    (ODC Space)
     W.L. Taber         (JPL)
     I.M. Underwood     (JPL)

Version

    SPICELIB Version 1.1.0, 09-APR-2021 (JDR)

        Added IMPLICIT NONE statement.

        Edited the header to comply with NAIF standard.

    SPICELIB Version 1.0.1, 10-MAR-1992 (WLT)

        Comment section for permuted index source lines was added
        following the header.

    SPICELIB Version 1.0.0, 31-JAN-1990 (IMU)