htswanalysis/MACS/lib/gsl/gsl-1.11/permutation/gsl_permutation.h

   1 /* permutation/gsl_permutation.h
   2  *
   3  * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2004, 2007 Brian Gough
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or (at
   8  * your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __GSL_PERMUTATION_H__
  21 #define __GSL_PERMUTATION_H__
  22
  23 #include <stdlib.h>
  24 #include <gsl/gsl_types.h>
  25 #include <gsl/gsl_errno.h>
  26 #include <gsl/gsl_check_range.h>
  27
  28 #undef __BEGIN_DECLS
  29 #undef __END_DECLS
  30 #ifdef __cplusplus
  31 # define __BEGIN_DECLS extern "C" {
  32 # define __END_DECLS }
  33 #else
  34 # define __BEGIN_DECLS /* empty */
  35 # define __END_DECLS /* empty */
  36 #endif
  37
  38 __BEGIN_DECLS
  39
  40 struct gsl_permutation_struct
  41 {
  42   size_t size;
  43   size_t *data;
  44 };
  45
  46 typedef struct gsl_permutation_struct gsl_permutation;
  47
  48 gsl_permutation *gsl_permutation_alloc (const size_t n);
  49 gsl_permutation *gsl_permutation_calloc (const size_t n);
  50 void gsl_permutation_init (gsl_permutation * p);
  51 void gsl_permutation_free (gsl_permutation * p);
  52 int gsl_permutation_memcpy (gsl_permutation * dest, const gsl_permutation * src);
  53
  54 int gsl_permutation_fread (FILE * stream, gsl_permutation * p);
  55 int gsl_permutation_fwrite (FILE * stream, const gsl_permutation * p);
  56 int gsl_permutation_fscanf (FILE * stream, gsl_permutation * p);
  57 int gsl_permutation_fprintf (FILE * stream, const gsl_permutation * p, const char *format);
  58
  59 size_t gsl_permutation_size (const gsl_permutation * p);
  60 size_t * gsl_permutation_data (const gsl_permutation * p);
  61
  62 size_t gsl_permutation_get (const gsl_permutation * p, const size_t i);
  63 int gsl_permutation_swap (gsl_permutation * p, const size_t i, const size_t j);
  64
  65 int gsl_permutation_valid (const gsl_permutation * p);
  66 void gsl_permutation_reverse (gsl_permutation * p);
  67 int gsl_permutation_inverse (gsl_permutation * inv, const gsl_permutation * p);
  68 int gsl_permutation_next (gsl_permutation * p);
  69 int gsl_permutation_prev (gsl_permutation * p);
  70 int gsl_permutation_mul (gsl_permutation * p, const gsl_permutation * pa, const gsl_permutation * pb);
  71
  72 int gsl_permutation_linear_to_canonical (gsl_permutation * q, const gsl_permutation * p);
  73 int gsl_permutation_canonical_to_linear (gsl_permutation * p, const gsl_permutation * q);
  74
  75 size_t gsl_permutation_inversions (const gsl_permutation * p);
  76 size_t gsl_permutation_linear_cycles (const gsl_permutation * p);
  77 size_t gsl_permutation_canonical_cycles (const gsl_permutation * q);
  78
  79 #ifdef HAVE_INLINE
  80
  81 extern inline
  82 size_t
  83 gsl_permutation_get (const gsl_permutation * p, const size_t i)
  84 {
  85 #if GSL_RANGE_CHECK
  86   if (i >= p->size)
  87     {
  88       GSL_ERROR_VAL ("index out of range", GSL_EINVAL, 0);
  89     }
  90 #endif
  91   return p->data[i];
  92 }
  93
  94 #endif /* HAVE_INLINE */
  95
  96 __END_DECLS
  97
  98 #endif /* __GSL_PERMUTATION_H__ */