util/X86LINUX64/include/gsl/gsl_vector_short.h

   1 /* vector/gsl_vector_short.h
   2  *
   3  * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Gerard Jungman, 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_VECTOR_SHORT_H__
  21 #define __GSL_VECTOR_SHORT_H__
  22
  23 #include <stdlib.h>
  24 #include <gsl/gsl_types.h>
  25 #include <gsl/gsl_errno.h>
  26 #include <gsl/gsl_inline.h>
  27 #include <gsl/gsl_check_range.h>
  28 #include <gsl/gsl_block_short.h>
  29
  30 #undef __BEGIN_DECLS
  31 #undef __END_DECLS
  32 #ifdef __cplusplus
  33 # define __BEGIN_DECLS extern "C" {
  34 # define __END_DECLS }
  35 #else
  36 # define __BEGIN_DECLS /* empty */
  37 # define __END_DECLS /* empty */
  38 #endif
  39
  40 __BEGIN_DECLS
  41
  42 typedef struct
  43 {
  44   size_t size;
  45   size_t stride;
  46   short *data;
  47   gsl_block_short *block;
  48   int owner;
  49 }
  50 gsl_vector_short;
  51
  52 typedef struct
  53 {
  54   gsl_vector_short vector;
  55 } _gsl_vector_short_view;
  56
  57 typedef _gsl_vector_short_view gsl_vector_short_view;
  58
  59 typedef struct
  60 {
  61   gsl_vector_short vector;
  62 } _gsl_vector_short_const_view;
  63
  64 typedef const _gsl_vector_short_const_view gsl_vector_short_const_view;
  65
  66
  67 /* Allocation */
  68
  69 gsl_vector_short *gsl_vector_short_alloc (const size_t n);
  70 gsl_vector_short *gsl_vector_short_calloc (const size_t n);
  71
  72 gsl_vector_short *gsl_vector_short_alloc_from_block (gsl_block_short * b,
  73                                                      const size_t offset,
  74                                                      const size_t n,
  75                                                      const size_t stride);
  76
  77 gsl_vector_short *gsl_vector_short_alloc_from_vector (gsl_vector_short * v,
  78                                                       const size_t offset,
  79                                                       const size_t n,
  80                                                       const size_t stride);
  81
  82 void gsl_vector_short_free (gsl_vector_short * v);
  83
  84 /* Views */
  85
  86 _gsl_vector_short_view
  87 gsl_vector_short_view_array (short *v, size_t n);
  88
  89 _gsl_vector_short_view
  90 gsl_vector_short_view_array_with_stride (short *base,
  91                                          size_t stride,
  92                                          size_t n);
  93
  94 _gsl_vector_short_const_view
  95 gsl_vector_short_const_view_array (const short *v, size_t n);
  96
  97 _gsl_vector_short_const_view
  98 gsl_vector_short_const_view_array_with_stride (const short *base,
  99                                                size_t stride,
 100                                                size_t n);
 101
 102 _gsl_vector_short_view
 103 gsl_vector_short_subvector (gsl_vector_short *v,
 104                             size_t i,
 105                             size_t n);
 106
 107 _gsl_vector_short_view
 108 gsl_vector_short_subvector_with_stride (gsl_vector_short *v,
 109                                         size_t i,
 110                                         size_t stride,
 111                                         size_t n);
 112
 113 _gsl_vector_short_const_view
 114 gsl_vector_short_const_subvector (const gsl_vector_short *v,
 115                                   size_t i,
 116                                   size_t n);
 117
 118 _gsl_vector_short_const_view
 119 gsl_vector_short_const_subvector_with_stride (const gsl_vector_short *v,
 120                                               size_t i,
 121                                               size_t stride,
 122                                               size_t n);
 123
 124 /* Operations */
 125
 126 void gsl_vector_short_set_zero (gsl_vector_short * v);
 127 void gsl_vector_short_set_all (gsl_vector_short * v, short x);
 128 int gsl_vector_short_set_basis (gsl_vector_short * v, size_t i);
 129
 130 int gsl_vector_short_fread (FILE * stream, gsl_vector_short * v);
 131 int gsl_vector_short_fwrite (FILE * stream, const gsl_vector_short * v);
 132 int gsl_vector_short_fscanf (FILE * stream, gsl_vector_short * v);
 133 int gsl_vector_short_fprintf (FILE * stream, const gsl_vector_short * v,
 134                               const char *format);
 135
 136 int gsl_vector_short_memcpy (gsl_vector_short * dest, const gsl_vector_short * src);
 137
 138 int gsl_vector_short_reverse (gsl_vector_short * v);
 139
 140 int gsl_vector_short_swap (gsl_vector_short * v, gsl_vector_short * w);
 141 int gsl_vector_short_swap_elements (gsl_vector_short * v, const size_t i, const size_t j);
 142
 143 short gsl_vector_short_max (const gsl_vector_short * v);
 144 short gsl_vector_short_min (const gsl_vector_short * v);
 145 void gsl_vector_short_minmax (const gsl_vector_short * v, short * min_out, short * max_out);
 146
 147 size_t gsl_vector_short_max_index (const gsl_vector_short * v);
 148 size_t gsl_vector_short_min_index (const gsl_vector_short * v);
 149 void gsl_vector_short_minmax_index (const gsl_vector_short * v, size_t * imin, size_t * imax);
 150
 151 int gsl_vector_short_add (gsl_vector_short * a, const gsl_vector_short * b);
 152 int gsl_vector_short_sub (gsl_vector_short * a, const gsl_vector_short * b);
 153 int gsl_vector_short_mul (gsl_vector_short * a, const gsl_vector_short * b);
 154 int gsl_vector_short_div (gsl_vector_short * a, const gsl_vector_short * b);
 155 int gsl_vector_short_scale (gsl_vector_short * a, const double x);
 156 int gsl_vector_short_add_constant (gsl_vector_short * a, const double x);
 157
 158 int gsl_vector_short_equal (const gsl_vector_short * u,
 159                             const gsl_vector_short * v);
 160
 161 int gsl_vector_short_isnull (const gsl_vector_short * v);
 162 int gsl_vector_short_ispos (const gsl_vector_short * v);
 163 int gsl_vector_short_isneg (const gsl_vector_short * v);
 164 int gsl_vector_short_isnonneg (const gsl_vector_short * v);
 165
 166 INLINE_DECL short gsl_vector_short_get (const gsl_vector_short * v, const size_t i);
 167 INLINE_DECL void gsl_vector_short_set (gsl_vector_short * v, const size_t i, short x);
 168 INLINE_DECL short * gsl_vector_short_ptr (gsl_vector_short * v, const size_t i);
 169 INLINE_DECL const short * gsl_vector_short_const_ptr (const gsl_vector_short * v, const size_t i);
 170
 171 #ifdef HAVE_INLINE
 172
 173 INLINE_FUN
 174 short
 175 gsl_vector_short_get (const gsl_vector_short * v, const size_t i)
 176 {
 177 #if GSL_RANGE_CHECK
 178   if (GSL_RANGE_COND(i >= v->size))
 179     {
 180       GSL_ERROR_VAL ("index out of range", GSL_EINVAL, 0);
 181     }
 182 #endif
 183   return v->data[i * v->stride];
 184 }
 185
 186 INLINE_FUN
 187 void
 188 gsl_vector_short_set (gsl_vector_short * v, const size_t i, short x)
 189 {
 190 #if GSL_RANGE_CHECK
 191   if (GSL_RANGE_COND(i >= v->size))
 192     {
 193       GSL_ERROR_VOID ("index out of range", GSL_EINVAL);
 194     }
 195 #endif
 196   v->data[i * v->stride] = x;
 197 }
 198
 199 INLINE_FUN
 200 short *
 201 gsl_vector_short_ptr (gsl_vector_short * v, const size_t i)
 202 {
 203 #if GSL_RANGE_CHECK
 204   if (GSL_RANGE_COND(i >= v->size))
 205     {
 206       GSL_ERROR_NULL ("index out of range", GSL_EINVAL);
 207     }
 208 #endif
 209   return (short *) (v->data + i * v->stride);
 210 }
 211
 212 INLINE_FUN
 213 const short *
 214 gsl_vector_short_const_ptr (const gsl_vector_short * v, const size_t i)
 215 {
 216 #if GSL_RANGE_CHECK
 217   if (GSL_RANGE_COND(i >= v->size))
 218     {
 219       GSL_ERROR_NULL ("index out of range", GSL_EINVAL);
 220     }
 221 #endif
 222   return (const short *) (v->data + i * v->stride);
 223 }
 224 #endif /* HAVE_INLINE */
 225
 226 __END_DECLS
 227
 228 #endif /* __GSL_VECTOR_SHORT_H__ */
 229
 230