cta_util_sort.h

Go to the documentation of this file.

/*
COSTA: Problem solving environment for data assimilation
Copyright (C) 2007  Nils van Velzen

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/**
\file  cta_util_sort.h
\brief Interface to the sorting utility functions of COSTA. 
       This header file handles the C/FORTRAN interfacing 
*/

#ifndef CTA_UTILSORT_H
#define CTA_UTILSORT_H

#include "cta_system.h"


#define CTA_IQSort2 F77_FUNC(cta_iqsort2,CTA_IQSORT2)
#ifdef __cplusplus
extern "C" /* prevent C++ name mangling */
#endif

/** \brief Sort an integer array using the Quicksort algorithm.
 *  An additional interger array is permutated in way as the unsorted array
 *
 *  \param id      (input) CHARACTER*1
 *  -        = 'I': sort D in increasing order;
 *  -        = 'D': sort D in decreasing order.
 *
 *  \param n       (input) INTEGER
 *          The length of the array D.
 *
 *  \param d       (input/output) array, dimension (N)
 *          On entry, the array to be sorted.
 *          On exit, D has been sorted into increasing order
 * -        (D(1) <= ... <= D(N) ) or into decreasing order
 * -        (D(1) >= ... >= D(N) ), depending on ID.
 *
 * \param dextra (input/output) array, dimension (N)
 *
 *  \param info    (output) INTEGER
 *  -        = 0:  successful exit
 *  -        < 0:  if INFO = -i, the i-th argument had an illegal value
 *
 * \return error status: CTA_OK if successful
 */
CTAEXPORT void CTA_IQSort2(char *id, int *n, int *d, int *dextra, int *info);

#define CTA_DQSort2 F77_FUNC(cta_dqsort2,CTA_DQSORT2)
#ifdef __cplusplus
extern "C" /* prevent C++ name mangling */
#endif

/** \brief Sort an double array using the Quicksort algorithm.
 *  An additional interger array is permutated in way as the unsorted array
 *
 *  \param id      (input) CHARACTER*1
 *  -        = 'I': sort D in increasing order;
 *  -        = 'D': sort D in decreasing order.
 *
 *  \param n       (input) INTEGER
 *          The length of the array D.
 *
 *  \param d       (input/output) array, dimension (N)
 *          On entry, the array to be sorted.
 *          On exit, D has been sorted into increasing order
 * -        (D(1) <= ... <= D(N) ) or into decreasing order
 * -        (D(1) >= ... >= D(N) ), depending on ID.
 *
 * \param dextra (input/output) array, dimension (N)
 *
 *  \param info    (output) INTEGER
 *  -        = 0:  successful exit
 *  -        < 0:  if INFO = -i, the i-th argument had an illegal value
 *
 * \return error status: CTA_OK if successful
 */
CTAEXPORT void CTA_DQSort2(char *id, int *n, double *d, int *dextra, int *info);

#endif

---