blob: 45218cfcc74cde5d0a33899c9e24f7a7b02d8fab [file] [log] [blame]
/* vector/gsl_vector_short.h
*
* Copyright (C) 1996, 1997, 1998, 1999, 2000 Gerard Jungman, Brian Gough
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __GSL_VECTOR_SHORT_H__
#define __GSL_VECTOR_SHORT_H__
#include <stdlib.h>
#include <gsl/gsl_types.h>
#include <gsl/gsl_errno.h>
#include <gsl/gsl_check_range.h>
#include <gsl/gsl_block_short.h>
#undef __BEGIN_DECLS
#undef __END_DECLS
#ifdef __cplusplus
# define __BEGIN_DECLS extern "C" {
# define __END_DECLS }
#else
# define __BEGIN_DECLS /* empty */
# define __END_DECLS /* empty */
#endif
__BEGIN_DECLS
typedef struct
{
size_t size;
size_t stride;
short *data;
gsl_block_short *block;
int owner;
}
gsl_vector_short;
typedef struct
{
gsl_vector_short vector;
} _gsl_vector_short_view;
typedef _gsl_vector_short_view gsl_vector_short_view;
typedef struct
{
gsl_vector_short vector;
} _gsl_vector_short_const_view;
typedef const _gsl_vector_short_const_view gsl_vector_short_const_view;
/* Allocation */
gsl_vector_short *gsl_vector_short_alloc (const size_t n);
gsl_vector_short *gsl_vector_short_calloc (const size_t n);
gsl_vector_short *gsl_vector_short_alloc_from_block (gsl_block_short * b,
const size_t offset,
const size_t n,
const size_t stride);
gsl_vector_short *gsl_vector_short_alloc_from_vector (gsl_vector_short * v,
const size_t offset,
const size_t n,
const size_t stride);
void gsl_vector_short_free (gsl_vector_short * v);
/* Views */
_gsl_vector_short_view
gsl_vector_short_view_array (short *v, size_t n);
_gsl_vector_short_view
gsl_vector_short_view_array_with_stride (short *base,
size_t stride,
size_t n);
_gsl_vector_short_const_view
gsl_vector_short_const_view_array (const short *v, size_t n);
_gsl_vector_short_const_view
gsl_vector_short_const_view_array_with_stride (const short *base,
size_t stride,
size_t n);
_gsl_vector_short_view
gsl_vector_short_subvector (gsl_vector_short *v,
size_t i,
size_t n);
_gsl_vector_short_view
gsl_vector_short_subvector_with_stride (gsl_vector_short *v,
size_t i,
size_t stride,
size_t n);
_gsl_vector_short_const_view
gsl_vector_short_const_subvector (const gsl_vector_short *v,
size_t i,
size_t n);
_gsl_vector_short_const_view
gsl_vector_short_const_subvector_with_stride (const gsl_vector_short *v,
size_t i,
size_t stride,
size_t n);
/* Operations */
short gsl_vector_short_get (const gsl_vector_short * v, const size_t i);
void gsl_vector_short_set (gsl_vector_short * v, const size_t i, short x);
short *gsl_vector_short_ptr (gsl_vector_short * v, const size_t i);
const short *gsl_vector_short_const_ptr (const gsl_vector_short * v, const size_t i);
void gsl_vector_short_set_zero (gsl_vector_short * v);
void gsl_vector_short_set_all (gsl_vector_short * v, short x);
int gsl_vector_short_set_basis (gsl_vector_short * v, size_t i);
int gsl_vector_short_fread (FILE * stream, gsl_vector_short * v);
int gsl_vector_short_fwrite (FILE * stream, const gsl_vector_short * v);
int gsl_vector_short_fscanf (FILE * stream, gsl_vector_short * v);
int gsl_vector_short_fprintf (FILE * stream, const gsl_vector_short * v,
const char *format);
int gsl_vector_short_memcpy (gsl_vector_short * dest, const gsl_vector_short * src);
int gsl_vector_short_reverse (gsl_vector_short * v);
int gsl_vector_short_swap (gsl_vector_short * v, gsl_vector_short * w);
int gsl_vector_short_swap_elements (gsl_vector_short * v, const size_t i, const size_t j);
short gsl_vector_short_max (const gsl_vector_short * v);
short gsl_vector_short_min (const gsl_vector_short * v);
void gsl_vector_short_minmax (const gsl_vector_short * v, short * min_out, short * max_out);
size_t gsl_vector_short_max_index (const gsl_vector_short * v);
size_t gsl_vector_short_min_index (const gsl_vector_short * v);
void gsl_vector_short_minmax_index (const gsl_vector_short * v, size_t * imin, size_t * imax);
int gsl_vector_short_add (gsl_vector_short * a, const gsl_vector_short * b);
int gsl_vector_short_sub (gsl_vector_short * a, const gsl_vector_short * b);
int gsl_vector_short_mul (gsl_vector_short * a, const gsl_vector_short * b);
int gsl_vector_short_div (gsl_vector_short * a, const gsl_vector_short * b);
int gsl_vector_short_scale (gsl_vector_short * a, const double x);
int gsl_vector_short_add_constant (gsl_vector_short * a, const double x);
int gsl_vector_short_isnull (const gsl_vector_short * v);
int gsl_vector_short_ispos (const gsl_vector_short * v);
int gsl_vector_short_isneg (const gsl_vector_short * v);
#ifdef HAVE_INLINE
extern inline
short
gsl_vector_short_get (const gsl_vector_short * v, const size_t i)
{
#if GSL_RANGE_CHECK
if (i >= v->size)
{
GSL_ERROR_VAL ("index out of range", GSL_EINVAL, 0);
}
#endif
return v->data[i * v->stride];
}
extern inline
void
gsl_vector_short_set (gsl_vector_short * v, const size_t i, short x)
{
#if GSL_RANGE_CHECK
if (i >= v->size)
{
GSL_ERROR_VOID ("index out of range", GSL_EINVAL);
}
#endif
v->data[i * v->stride] = x;
}
extern inline
short *
gsl_vector_short_ptr (gsl_vector_short * v, const size_t i)
{
#if GSL_RANGE_CHECK
if (i >= v->size)
{
GSL_ERROR_NULL ("index out of range", GSL_EINVAL);
}
#endif
return (short *) (v->data + i * v->stride);
}
extern inline
const short *
gsl_vector_short_const_ptr (const gsl_vector_short * v, const size_t i)
{
#if GSL_RANGE_CHECK
if (i >= v->size)
{
GSL_ERROR_NULL ("index out of range", GSL_EINVAL);
}
#endif
return (const short *) (v->data + i * v->stride);
}
#endif /* HAVE_INLINE */
__END_DECLS
#endif /* __GSL_VECTOR_SHORT_H__ */