vec_gen.h

Go to the documentation of this file.

/* 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
*/

#ifndef _GAN_VEC_GEN_H
#define _GAN_VEC_GEN_H

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <gandalf/common/misc_defs.h>
#include <gandalf/common/misc_error.h>

#ifdef __cplusplus
extern "C" {
#endif

struct Gan_Matrix;

typedef struct Gan_Vector
{
   /* size of column vector */
   unsigned long rows;

   /* data array containing vector elements */
   double *data;

   /* allocated size of vector (number of double's) */
   size_t data_size;

   /* flag indicating whether vector data was dynamically allocated */
   Gan_Bool data_alloc;

   /* flag indicating whether vector structure was dynamically allocated */
   Gan_Bool struct_alloc;
} Gan_Vector;

#define GAN_VECTOR_STRUCT_DEFINED

#include <gandalf/linalg/mat_gen.h>
#include <gandalf/linalg/mat_square.h>

/* function declarations */
 Gan_Vector *gan_vec_form_gen ( Gan_Vector *x, unsigned long rows,
                               double *data, size_t data_size );
 void gan_vec_free ( Gan_Vector *x );
 Gan_Vector *gan_vec_set_size ( Gan_Vector *x, unsigned long rows );
 Gan_Vector *gan_vec_fill_va ( Gan_Vector *x, unsigned long rows, ... );
 Gan_Vector *gan_vec_fill_vap ( Gan_Vector *x, unsigned long rows,
                               va_list *aptr );
 Gan_Vector *gan_vec_fill_const_q ( Gan_Vector *x, unsigned long rows,
                                   double value );
 Gan_Bool gan_vec_read_va ( const Gan_Vector *x, unsigned long rows, ... );
 Gan_Vector *gan_vec_copy_q ( const Gan_Vector *x, Gan_Vector *y );
 Gan_Vector *gan_vec_scale_q ( Gan_Vector *x, double a, Gan_Vector *y );
 Gan_Vector *gan_vec_add_q ( Gan_Vector *x, Gan_Vector *y, Gan_Vector *z );
 Gan_Vector *gan_vec_sub_q ( Gan_Vector *x, Gan_Vector *y, Gan_Vector *z );
 double gan_vec_dot ( const Gan_Vector *x, const Gan_Vector *y );
 struct Gan_Matrix *gan_vec_outer_q ( const Gan_Vector *x, const Gan_Vector *y,
                                     struct Gan_Matrix *A );
 struct Gan_SquMatrix *gan_vec_outer_sym_q ( const Gan_Vector *x,
                                            struct Gan_SquMatrix *A );
 Gan_Vector *gan_vec_insert ( Gan_Vector *x, unsigned long rx,
                             const Gan_Vector *y, unsigned long ry,
                             unsigned long rows );
 void gan_vec_free_va ( Gan_Vector *x, ... );
 Gan_Vector *gan_vec_insert_mat ( Gan_Vector *x, unsigned long rx,
                                 const struct Gan_Matrix *A, unsigned long ra,
                                                             unsigned long ca,
                                 unsigned long rows );
 Gan_Vector *gan_vec_insert_matT ( Gan_Vector *x, unsigned long rx,
                                  const struct Gan_Matrix *A, unsigned long ra,
                                                              unsigned long ca,
                                  unsigned long rows );
 Gan_Bool gan_vec_fprint ( FILE *fp, const Gan_Vector *x, const char *prefix,
                          int indent, const char *fmt );
 Gan_Vector *gan_vec_fscanf_q ( FILE *fp, Gan_Vector *x,
                               char *prefix, int prefix_len );
 Gan_Bool gan_vec_fwrite ( FILE *fp, const Gan_Vector *x, gan_uint32 magic_number );
 Gan_Vector *gan_vec_fread_q ( FILE *fp, Gan_Vector *x,
                              gan_uint32 *magic_number );

#define Gan_Matrix    struct Gan_Matrix
#define Gan_SquMatrix struct Gan_SquMatrix

 Gan_Vector *gan_vec_alloc ( unsigned long rows );

 Gan_Vector *gan_vec_form ( Gan_Vector *x, unsigned long rows );

 Gan_Vector *gan_vec_form_data ( Gan_Vector *x, unsigned long rows,
                                void *data, size_t data_size );

 Gan_Bool gan_vec_set_el ( Gan_Vector *x, unsigned i, double value );

 double gan_vec_get_el ( const Gan_Vector *x, unsigned i );

 Gan_Bool gan_vec_inc_el ( Gan_Vector *x, unsigned i, double value );

 Gan_Bool gan_vec_dec_el ( Gan_Vector *x, unsigned i, double value );

 Gan_Bool gan_vec_print ( const Gan_Vector *x,
                         const char *prefix, int indent, const char *fmt );

 Gan_Vector *gan_vec_fill_const_s ( unsigned long rows, double value );

 Gan_Vector *gan_vec_fill_zero_q ( Gan_Vector *x, unsigned long rows );

 Gan_Vector *gan_vec_fill_zero_s ( unsigned long rows );

 Gan_Vector *gan_vec_copy_s ( const Gan_Vector *x );

 Gan_Vector *gan_vec_scale_s ( Gan_Vector *x, double a );

 Gan_Vector *gan_vec_scale_i ( Gan_Vector *x, double a );

 Gan_Vector *gan_vec_divide_q ( Gan_Vector *x, double a, Gan_Vector *y );

 Gan_Vector *gan_vec_divide_s ( Gan_Vector *x, double a );

 Gan_Vector *gan_vec_divide_i ( Gan_Vector *x, double a );

 Gan_Vector *gan_vec_negate_q ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_negate_s ( Gan_Vector *x );

 Gan_Vector *gan_vec_negate_i ( Gan_Vector *x );

 Gan_Vector *gan_vec_add_s ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_add_i1 ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_add_i2 ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_increment ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_sub_s ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_sub_i1 ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_sub_i2 ( Gan_Vector *x, Gan_Vector *y );

 Gan_Vector *gan_vec_decrement ( Gan_Vector *x, Gan_Vector *y );

 Gan_Matrix *gan_vec_outer_s ( const Gan_Vector *x, const Gan_Vector *y );

 Gan_SquMatrix *gan_vec_outer_sym_s ( const Gan_Vector *x );

 double gan_vec_sqrlen ( const Gan_Vector *x );

 Gan_Bool gan_vec_same_size ( const Gan_Vector *x, const Gan_Vector *y );

 size_t gan_vec_data_size ( unsigned long rows );

 Gan_Vector *gan_vec_fscanf_s ( FILE *fp, const char *prefix, int prefix_len );

 Gan_Vector *gan_vec_fread_s ( FILE *fp, gan_uint32 *magic_number );

#undef Gan_Matrix
#undef Gan_SquMatrix

/* not user functions */
 Gan_Bool gan_vec_realloc ( Gan_Vector *x, unsigned long rows );
#ifndef NDEBUG
 void gan_vec_db ( const Gan_Vector *x ); /* for use in a debugger */
#endif

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _GAN_VEC_GEN_H */

---