Procedure

     CPOS ( Character position )

     INTEGER FUNCTION CPOS ( STR, CHARS, START )

Abstract

     Find the first occurrence in a string of a character belonging
     to a collection of characters, starting at a specified location,
     searching forward.

Required_Reading

     SCANNING

Keywords

     CHARACTER
     SEARCH
     UTILITY

Declarations

     IMPLICIT NONE

     CHARACTER*(*)         STR
     CHARACTER*(*)         CHARS
     INTEGER               START

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     STR        I   Any character string.
     CHARS      I   A collection of characters.
     START      I   Position to begin looking for one of CHARS

     The function returns the index of the first character of STR
     at or following index START that is in the collection CHARS.

Detailed_Input

     STR      is any character string.

     CHARS    is a character string containing a collection
              of characters. Spaces in CHARS are significant.

     START    is the position in STR to begin looking for one of
              the characters in CHARS.

Detailed_Output

     The function returns the index of the first character of STR
     (at or following index START) that is one of the characters in
     the string CHARS. If none of the characters is found, the
     function returns zero.

Parameters

     None.

Exceptions

     Error free.

     1)  If START is less than 1, the search begins at the first
         character of the string.

     2)  If START is greater than the length of the string, CPOS
         returns zero.

Files

     None.

Particulars

     CPOS is case sensitive.

     An entire family of related SPICELIB routines (POS, CPOS, NCPOS,
     POSR, CPOSR, NCPOSR) is described in the Required Reading.

     Those familiar with the True BASIC language should note that
     these functions are equivalent to the True BASIC intrinsic
     functions with the same names.

Examples

     Let STRING = 'BOB, JOHN, TED, AND MARTIN....'
                   123456789012345678901234567890

     Normal (sequential) searching
     -----------------------------

           CPOS( STRING, ' ,',    1  ) =  4

           CPOS( STRING, ' ,',    5  ) =  5

           CPOS( STRING, ' ,',    6  ) = 10

           CPOS( STRING, ' ,',    11 ) = 11

           CPOS( STRING, ' ,',    12 ) = 15

           CPOS( STRING, ' ,',    16 ) = 16

           CPOS( STRING, ' ,',    17 ) = 20

           CPOS( STRING, ' ,',    21 ) = 0


     START out of bounds
     -------------------

           CPOS( STRING, ' ,',  -113 ) = 4

           CPOS( STRING, ' ,',    -1 ) = 4

           CPOS( STRING, ' ,',    31 ) = 0

           CPOS( STRING, ' ,',  1231 ) = 0


     Order within CHARS
     ------------------

           CPOS( STRING, ',. ',   22 ) = 27

           CPOS( STRING, ' ,.',   22 ) = 27

           CPOS( STRING, ', .',   22 ) = 27

Restrictions

     None.

Literature_References

     None.

Author_and_Institution

     J. Diaz del Rio    (ODC Space)
     H.A. Neilan        (JPL)
     B.V. Semenov       (JPL)
     W.L. Taber         (JPL)

Version

    SPICELIB Version 1.1.0, 02-JUL-2021 (JDR)

        Added IMPLICIT NONE statement.

        Edited the header to comply with NAIF standard.

    SPICELIB Version 1.0.3, 31-JAN-2008 (BVS)

        Removed non-standard end-of-declarations marker
        'C%&END_DECLARATIONS' from comments.

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

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

    SPICELIB Version 1.0.1, 26-MAR-1991 (HAN)

        The Required Reading file POSITION was renamed to SCANNING.
        This header was updated to reflect the change.

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