Blame vector/gsl_vector_long.h

Packit 67cb25
/* vector/gsl_vector_long.h
Packit 67cb25
 * 
Packit 67cb25
 * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Gerard Jungman, Brian Gough
Packit 67cb25
 * 
Packit 67cb25
 * This program is free software; you can redistribute it and/or modify
Packit 67cb25
 * it under the terms of the GNU General Public License as published by
Packit 67cb25
 * the Free Software Foundation; either version 3 of the License, or (at
Packit 67cb25
 * your option) any later version.
Packit 67cb25
 * 
Packit 67cb25
 * This program is distributed in the hope that it will be useful, but
Packit 67cb25
 * WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 67cb25
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 67cb25
 * General Public License for more details.
Packit 67cb25
 * 
Packit 67cb25
 * You should have received a copy of the GNU General Public License
Packit 67cb25
 * along with this program; if not, write to the Free Software
Packit 67cb25
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Packit 67cb25
 */
Packit 67cb25
Packit 67cb25
#ifndef __GSL_VECTOR_LONG_H__
Packit 67cb25
#define __GSL_VECTOR_LONG_H__
Packit 67cb25
Packit 67cb25
#include <stdlib.h>
Packit 67cb25
#include <gsl/gsl_types.h>
Packit 67cb25
#include <gsl/gsl_errno.h>
Packit 67cb25
#include <gsl/gsl_inline.h>
Packit 67cb25
#include <gsl/gsl_check_range.h>
Packit 67cb25
#include <gsl/gsl_block_long.h>
Packit 67cb25
Packit 67cb25
#undef __BEGIN_DECLS
Packit 67cb25
#undef __END_DECLS
Packit 67cb25
#ifdef __cplusplus
Packit 67cb25
# define __BEGIN_DECLS extern "C" {
Packit 67cb25
# define __END_DECLS }
Packit 67cb25
#else
Packit 67cb25
# define __BEGIN_DECLS /* empty */
Packit 67cb25
# define __END_DECLS /* empty */
Packit 67cb25
#endif
Packit 67cb25
Packit 67cb25
__BEGIN_DECLS
Packit 67cb25
Packit 67cb25
typedef struct 
Packit 67cb25
{
Packit 67cb25
  size_t size;
Packit 67cb25
  size_t stride;
Packit 67cb25
  long *data;
Packit 67cb25
  gsl_block_long *block;
Packit 67cb25
  int owner;
Packit 67cb25
} 
Packit 67cb25
gsl_vector_long;
Packit 67cb25
Packit 67cb25
typedef struct
Packit 67cb25
{
Packit 67cb25
  gsl_vector_long vector;
Packit 67cb25
} _gsl_vector_long_view;
Packit 67cb25
Packit 67cb25
typedef _gsl_vector_long_view gsl_vector_long_view;
Packit 67cb25
Packit 67cb25
typedef struct
Packit 67cb25
{
Packit 67cb25
  gsl_vector_long vector;
Packit 67cb25
} _gsl_vector_long_const_view;
Packit 67cb25
Packit 67cb25
typedef const _gsl_vector_long_const_view gsl_vector_long_const_view;
Packit 67cb25
Packit 67cb25
Packit 67cb25
/* Allocation */
Packit 67cb25
Packit 67cb25
gsl_vector_long *gsl_vector_long_alloc (const size_t n);
Packit 67cb25
gsl_vector_long *gsl_vector_long_calloc (const size_t n);
Packit 67cb25
Packit 67cb25
gsl_vector_long *gsl_vector_long_alloc_from_block (gsl_block_long * b,
Packit 67cb25
                                                     const size_t offset, 
Packit 67cb25
                                                     const size_t n, 
Packit 67cb25
                                                     const size_t stride);
Packit 67cb25
Packit 67cb25
gsl_vector_long *gsl_vector_long_alloc_from_vector (gsl_vector_long * v,
Packit 67cb25
                                                      const size_t offset, 
Packit 67cb25
                                                      const size_t n, 
Packit 67cb25
                                                      const size_t stride);
Packit 67cb25
Packit 67cb25
void gsl_vector_long_free (gsl_vector_long * v);
Packit 67cb25
Packit 67cb25
/* Views */
Packit 67cb25
Packit 67cb25
_gsl_vector_long_view 
Packit 67cb25
gsl_vector_long_view_array (long *v, size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_view 
Packit 67cb25
gsl_vector_long_view_array_with_stride (long *base,
Packit 67cb25
                                         size_t stride,
Packit 67cb25
                                         size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_const_view 
Packit 67cb25
gsl_vector_long_const_view_array (const long *v, size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_const_view 
Packit 67cb25
gsl_vector_long_const_view_array_with_stride (const long *base,
Packit 67cb25
                                               size_t stride,
Packit 67cb25
                                               size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_view 
Packit 67cb25
gsl_vector_long_subvector (gsl_vector_long *v, 
Packit 67cb25
                            size_t i, 
Packit 67cb25
                            size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_view 
Packit 67cb25
gsl_vector_long_subvector_with_stride (gsl_vector_long *v, 
Packit 67cb25
                                        size_t i,
Packit 67cb25
                                        size_t stride,
Packit 67cb25
                                        size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_const_view 
Packit 67cb25
gsl_vector_long_const_subvector (const gsl_vector_long *v, 
Packit 67cb25
                                  size_t i, 
Packit 67cb25
                                  size_t n);
Packit 67cb25
Packit 67cb25
_gsl_vector_long_const_view 
Packit 67cb25
gsl_vector_long_const_subvector_with_stride (const gsl_vector_long *v, 
Packit 67cb25
                                              size_t i, 
Packit 67cb25
                                              size_t stride,
Packit 67cb25
                                              size_t n);
Packit 67cb25
Packit 67cb25
/* Operations */
Packit 67cb25
Packit 67cb25
void gsl_vector_long_set_zero (gsl_vector_long * v);
Packit 67cb25
void gsl_vector_long_set_all (gsl_vector_long * v, long x);
Packit 67cb25
int gsl_vector_long_set_basis (gsl_vector_long * v, size_t i);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_fread (FILE * stream, gsl_vector_long * v);
Packit 67cb25
int gsl_vector_long_fwrite (FILE * stream, const gsl_vector_long * v);
Packit 67cb25
int gsl_vector_long_fscanf (FILE * stream, gsl_vector_long * v);
Packit 67cb25
int gsl_vector_long_fprintf (FILE * stream, const gsl_vector_long * v,
Packit 67cb25
                              const char *format);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_memcpy (gsl_vector_long * dest, const gsl_vector_long * src);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_reverse (gsl_vector_long * v);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_swap (gsl_vector_long * v, gsl_vector_long * w);
Packit 67cb25
int gsl_vector_long_swap_elements (gsl_vector_long * v, const size_t i, const size_t j);
Packit 67cb25
Packit 67cb25
long gsl_vector_long_max (const gsl_vector_long * v);
Packit 67cb25
long gsl_vector_long_min (const gsl_vector_long * v);
Packit 67cb25
void gsl_vector_long_minmax (const gsl_vector_long * v, long * min_out, long * max_out);
Packit 67cb25
Packit 67cb25
size_t gsl_vector_long_max_index (const gsl_vector_long * v);
Packit 67cb25
size_t gsl_vector_long_min_index (const gsl_vector_long * v);
Packit 67cb25
void gsl_vector_long_minmax_index (const gsl_vector_long * v, size_t * imin, size_t * imax);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_add (gsl_vector_long * a, const gsl_vector_long * b);
Packit 67cb25
int gsl_vector_long_sub (gsl_vector_long * a, const gsl_vector_long * b);
Packit 67cb25
int gsl_vector_long_mul (gsl_vector_long * a, const gsl_vector_long * b);
Packit 67cb25
int gsl_vector_long_div (gsl_vector_long * a, const gsl_vector_long * b);
Packit 67cb25
int gsl_vector_long_scale (gsl_vector_long * a, const double x);
Packit 67cb25
int gsl_vector_long_add_constant (gsl_vector_long * a, const double x);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_equal (const gsl_vector_long * u, 
Packit 67cb25
                            const gsl_vector_long * v);
Packit 67cb25
Packit 67cb25
int gsl_vector_long_isnull (const gsl_vector_long * v);
Packit 67cb25
int gsl_vector_long_ispos (const gsl_vector_long * v);
Packit 67cb25
int gsl_vector_long_isneg (const gsl_vector_long * v);
Packit 67cb25
int gsl_vector_long_isnonneg (const gsl_vector_long * v);
Packit 67cb25
Packit 67cb25
INLINE_DECL long gsl_vector_long_get (const gsl_vector_long * v, const size_t i);
Packit 67cb25
INLINE_DECL void gsl_vector_long_set (gsl_vector_long * v, const size_t i, long x);
Packit 67cb25
INLINE_DECL long * gsl_vector_long_ptr (gsl_vector_long * v, const size_t i);
Packit 67cb25
INLINE_DECL const long * gsl_vector_long_const_ptr (const gsl_vector_long * v, const size_t i);
Packit 67cb25
Packit 67cb25
#ifdef HAVE_INLINE
Packit 67cb25
Packit 67cb25
INLINE_FUN
Packit 67cb25
long
Packit 67cb25
gsl_vector_long_get (const gsl_vector_long * v, const size_t i)
Packit 67cb25
{
Packit 67cb25
#if GSL_RANGE_CHECK
Packit 67cb25
  if (GSL_RANGE_COND(i >= v->size))
Packit 67cb25
    {
Packit 67cb25
      GSL_ERROR_VAL ("index out of range", GSL_EINVAL, 0);
Packit 67cb25
    }
Packit 67cb25
#endif
Packit 67cb25
  return v->data[i * v->stride];
Packit 67cb25
}
Packit 67cb25
Packit 67cb25
INLINE_FUN
Packit 67cb25
void
Packit 67cb25
gsl_vector_long_set (gsl_vector_long * v, const size_t i, long x)
Packit 67cb25
{
Packit 67cb25
#if GSL_RANGE_CHECK
Packit 67cb25
  if (GSL_RANGE_COND(i >= v->size))
Packit 67cb25
    {
Packit 67cb25
      GSL_ERROR_VOID ("index out of range", GSL_EINVAL);
Packit 67cb25
    }
Packit 67cb25
#endif
Packit 67cb25
  v->data[i * v->stride] = x;
Packit 67cb25
}
Packit 67cb25
Packit 67cb25
INLINE_FUN
Packit 67cb25
long *
Packit 67cb25
gsl_vector_long_ptr (gsl_vector_long * v, const size_t i)
Packit 67cb25
{
Packit 67cb25
#if GSL_RANGE_CHECK
Packit 67cb25
  if (GSL_RANGE_COND(i >= v->size))
Packit 67cb25
    {
Packit 67cb25
      GSL_ERROR_NULL ("index out of range", GSL_EINVAL);
Packit 67cb25
    }
Packit 67cb25
#endif
Packit 67cb25
  return (long *) (v->data + i * v->stride);
Packit 67cb25
}
Packit 67cb25
Packit 67cb25
INLINE_FUN
Packit 67cb25
const long *
Packit 67cb25
gsl_vector_long_const_ptr (const gsl_vector_long * v, const size_t i)
Packit 67cb25
{
Packit 67cb25
#if GSL_RANGE_CHECK
Packit 67cb25
  if (GSL_RANGE_COND(i >= v->size))
Packit 67cb25
    {
Packit 67cb25
      GSL_ERROR_NULL ("index out of range", GSL_EINVAL);
Packit 67cb25
    }
Packit 67cb25
#endif
Packit 67cb25
  return (const long *) (v->data + i * v->stride);
Packit 67cb25
}
Packit 67cb25
#endif /* HAVE_INLINE */
Packit 67cb25
Packit 67cb25
__END_DECLS
Packit 67cb25
Packit 67cb25
#endif /* __GSL_VECTOR_LONG_H__ */
Packit 67cb25
Packit 67cb25