Index of Functions: A B C D E F G H I J K L M N O P Q R S T U V W X
Index Page orderc_c

Table of contents

Procedure Abstract Required_Reading Keywords Brief_I/O Detailed_Input | Detailed_Output Parameters Exceptions Files Particulars Examples | Restrictions Literature_References Author_and_Institution Version Index_Entries

#### Procedure

       orderc_c ( Order of a character array )

       void orderc_c ( SpiceInt      arrlen,
                       const void  * array,
                       SpiceInt      ndim,
                       SpiceInt    * iorder  )

#### Abstract

       Determine the order of elements in an array of character strings.

#### Required_Reading

       None.

#### Keywords

       ARRAY
       SORT

#### Brief_I/O

       VARIABLE  I/O  DESCRIPTION
       --------  ---  --------------------------------------------------
       arrlen     I   String length.
       array      I   Input array.
       ndim       I   Dimension of array.
       iorder     O   Order vector for array.

#### Detailed_Input

       arrlen      is the declared length of the strings in the input
                   string array, including null terminators. The input
                   array should be declared with dimension

                      [ndim][arrlen]

       array       is the input array.

       ndim        is the number of elements in the input array.

#### Detailed_Output

       iorder      is the order vector for the input array.
                   iorder[0] is the index of the smallest element
                   of array; iorder[1] is the index of the next
                   smallest; and so on. Strings are ordered according
                   to the ASCII collating sequence. Trailing white space
                   is ignored when comparing strings.

                   The elements of iorder range from zero to ndim-1.

#### Parameters

       None.

#### Exceptions

       1)  If ndim < 1, this routine returns immediately. This case is not
           considered an error.

       2)  If the `array' input array pointer is null, the error
           SPICE(NULLPOINTER) is signaled.

       3)  If the `array' input array strings have length less than two
           characters, the error SPICE(STRINGTOOSHORT) is signaled.

#### Files

       None.

#### Particulars

       orderc_c finds the index of the smallest element of the input
       array. This becomes the first element of the order vector.
       The process is repeated for the rest of the elements.

       The order vector returned by orderc_c may be used by any of
       the reord* routines to sort sets of related arrays, as shown
       in the example below.

#### Examples

       The numerical results shown for this example may differ across
       platforms. The results depend on the SPICE kernels used as
       input, the compiler and supporting libraries, and the machine
       specific arithmetic implementation.

       1) Sort four related arrays containing the names, masses,
          integer ID codes, and flags indicating whether they have
          a ring system, for a group of planets.

          Example code begins here.

          /.
             Program orderc_ex1
          ./
          #include <stdio.h>
          #include "SpiceUsr.h"

          int main( )
          {

             /.
             Local constants.
             ./
             #define NDIM         8
             #define STRLEN       8

             /.
             Local variables.
             ./

             SpiceInt             i;
             SpiceInt             iorder [NDIM];

             /.
             Set the arrays containing the names, masses (given as
             ratios to of Solar GM to barycenter GM), integer ID
             codes, and flags indicating whether they have a ring
             system.
             ./
             SpiceChar            names  [NDIM][STRLEN] = {
                                     "MERCURY", "VENUS",  "EARTH",  "MARS",
                                     "JUPITER", "SATURN", "URANUS", "NEPTUNE" };

             SpiceDouble          masses [NDIM] = {     22032.080,   324858.599,
                                                       398600.436,    42828.314,
                                                    126712767.881, 37940626.068,
                                                      5794559.128,  6836534.065 };

             SpiceInt             codes  [NDIM] = { 199, 299, 399, 499,
                                                    599, 699, 799, 899 };

             SpiceBoolean         rings  [NDIM] = { SPICEFALSE, SPICEFALSE,
                                                    SPICEFALSE, SPICEFALSE,
                                                    SPICETRUE,  SPICETRUE,
                                                    SPICETRUE,  SPICETRUE  };

             /.
             Sort the object arrays by name.
             ./
             orderc_c ( STRLEN, names, NDIM,   iorder );

             reordc_c ( iorder, NDIM,  STRLEN, names  );
             reordd_c ( iorder, NDIM,  masses         );
             reordi_c ( iorder, NDIM,  codes          );
             reordl_c ( iorder, NDIM,  rings          );

             /.
             Output the resulting table.
             ./
             printf( " Planet   Mass(GMS/GM)  ID Code  Rings?\n" );
             printf( "-------  -------------  -------  ------\n" );

             for ( i = 0; i < NDIM; i++ )
             {

                printf( "%-7s %14.3f %8d %4d\n",
                        names[i], masses[i], codes[i], rings[i] );

             }

             return ( 0 );
          }

          When this program was executed on a Mac/Intel/cc/64-bit
          platform, the output was:

           Planet   Mass(GMS/GM)  ID Code  Rings?
          -------  -------------  -------  ------
          EARTH       398600.436      399    0
          JUPITER  126712767.881      599    1
          MARS         42828.314      499    0
          MERCURY      22032.080      199    0
          NEPTUNE    6836534.065      899    1
          SATURN    37940626.068      699    1
          URANUS     5794559.128      799    1
          VENUS       324858.599      299    0

#### Restrictions

       1)  String comparisons performed by this routine are Fortran-style:
           trailing blanks in the input array or key value are ignored.
           This gives consistent behavior with CSPICE code generated by
           the f2c translator, as well as with the Fortran SPICE Toolkit.

           Note that this behavior is not identical to that of the ANSI
           C library functions strcmp and strncmp.

#### Literature_References

       None.

#### Author_and_Institution

       N.J. Bachman        (JPL)
       J. Diaz del Rio     (ODC Space)
       I.M. Underwood      (JPL)

#### Version

       -CSPICE Version 1.1.0, 04-AUG-2021 (JDR)

           Changed input argument name "lenvals" to "arrlen" for consistency
           with other routines.

           Edited the header to comply with NAIF standard.
           Added complete code example.

       -CSPICE Version 1.0.0, 18-JUL-2002 (NJB) (IMU)

#### Index_Entries

       order of a character array

#### Link to routine orderc_c source file orderc_c.c

    Fri Dec 31 18:41:10 2021