vecf_gen.h

Go to the documentation of this file.

#ifndef _GAN_VECF_GEN_H
#define _GAN_VECF_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_f;

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

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

   /* allocated size of vector (number of float'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_f;

#define GAN_VECTORF_STRUCT_DEFINED

#include <gandalf/linalg/matf_gen.h>
#include <gandalf/linalg/matf_square.h>

/* function declarations */
 Gan_Vector_f *gan_vecf_form_gen ( Gan_Vector_f *x, unsigned long rows,
                                  float *data, size_t data_size );
 void gan_vecf_free ( Gan_Vector_f *x );
 Gan_Vector_f *gan_vecf_set_size ( Gan_Vector_f *x, unsigned long rows );
 Gan_Vector_f *gan_vecf_fill_va ( Gan_Vector_f *x, unsigned long rows, ... );
 Gan_Vector_f *gan_vecf_fill_vap ( Gan_Vector_f *x, unsigned long rows,
                               va_list *aptr );
 Gan_Vector_f *gan_vecf_fill_const_q ( Gan_Vector_f *x, unsigned long rows,
                                      float value );
 Gan_Bool gan_vecf_read_va ( const Gan_Vector_f *x, unsigned long rows, ... );
 Gan_Vector_f *gan_vecf_copy_q ( const Gan_Vector_f *x, Gan_Vector_f *y );
 Gan_Vector_f *gan_vecf_scale_q ( Gan_Vector_f *x, float a, Gan_Vector_f *y );
 Gan_Vector_f *gan_vecf_add_q ( Gan_Vector_f *x, Gan_Vector_f *y,
                               Gan_Vector_f *z );
 Gan_Vector_f *gan_vecf_sub_q ( Gan_Vector_f *x, Gan_Vector_f *y,
                               Gan_Vector_f *z );
 float gan_vecf_dot ( const Gan_Vector_f *x, const Gan_Vector_f *y );
 struct Gan_Matrix_f *gan_vecf_outer_q ( const Gan_Vector_f *x, const Gan_Vector_f *y,
                                        struct Gan_Matrix_f *A );
 struct Gan_SquMatrix_f *gan_vecf_outer_sym_q ( const Gan_Vector_f *x,
                                               struct Gan_SquMatrix_f *A );
 Gan_Vector_f *gan_vecf_insert ( Gan_Vector_f *x, unsigned long rx,
                                const Gan_Vector_f *y, unsigned long ry,
                                unsigned long rows );
 void gan_vecf_free_va ( Gan_Vector_f *x, ... );
 Gan_Vector_f *gan_vecf_insert_mat ( Gan_Vector_f *x, unsigned long rx,
                                    const struct Gan_Matrix_f *A, unsigned long ra,
                                                                  unsigned long ca,
                                    unsigned long rows );
 Gan_Vector_f *gan_vecf_insert_matT ( Gan_Vector_f *x, unsigned long rx,
                                     const struct Gan_Matrix_f *A, unsigned long ra,
                                                                   unsigned long ca,
                                     unsigned long rows );
 Gan_Bool gan_vecf_fprint ( FILE *fp, const Gan_Vector_f *x, const char *prefix,
                           int indent, const char *fmt );
 Gan_Vector_f *gan_vecf_fscanf_q ( FILE *fp, Gan_Vector_f *x,
                                  char *prefix, int prefix_len );
 Gan_Bool gan_vecf_fwrite ( FILE *fp, const Gan_Vector_f *x, gan_uint32 magic_number );
 Gan_Vector_f *gan_vecf_fread_q ( FILE *fp, Gan_Vector_f *x,
                                 gan_uint32 *magic_number );

#define Gan_Matrix_f    struct Gan_Matrix_f
#define Gan_SquMatrix_f struct Gan_SquMatrix_f

 Gan_Vector_f *gan_vecf_alloc ( unsigned long rows );

 Gan_Vector_f *gan_vecf_form ( Gan_Vector_f *x, unsigned long rows );

 Gan_Vector_f *gan_vecf_form_data ( Gan_Vector_f *x, unsigned long rows,
                                   void *data, size_t data_size );

 Gan_Bool gan_vecf_set_el ( Gan_Vector_f *x, unsigned i, float value );

 float gan_vecf_get_el ( const Gan_Vector_f *x, unsigned i );

 Gan_Bool gan_vecf_inc_el ( Gan_Vector_f *x, unsigned i, float value );

 Gan_Bool gan_vecf_dec_el ( Gan_Vector_f *x, unsigned i, float value );

 Gan_Bool gan_vecf_print ( const Gan_Vector_f *x,
                          const char *prefix, int indent, const char *fmt );

 Gan_Vector_f *gan_vecf_fill_const_s ( unsigned long rows, float value );

 Gan_Vector_f *gan_vecf_fill_zero_q ( Gan_Vector_f *x, unsigned long rows );

 Gan_Vector_f *gan_vecf_fill_zero_s ( unsigned long rows );

 Gan_Vector_f *gan_vecf_copy_s ( const Gan_Vector_f *x );

 Gan_Vector_f *gan_vecf_scale_s ( Gan_Vector_f *x, float a );

 Gan_Vector_f *gan_vecf_scale_i ( Gan_Vector_f *x, float a );

 Gan_Vector_f *gan_vecf_divide_q ( Gan_Vector_f *x, float a, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_divide_s ( Gan_Vector_f *x, float a );

 Gan_Vector_f *gan_vecf_divide_i ( Gan_Vector_f *x, float a );

 Gan_Vector_f *gan_vecf_negate_q ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_negate_s ( Gan_Vector_f *x );

 Gan_Vector_f *gan_vecf_negate_i ( Gan_Vector_f *x );

 Gan_Vector_f *gan_vecf_add_s ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_add_i1 ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_add_i2 ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_increment ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_sub_s ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_sub_i1 ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_sub_i2 ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Vector_f *gan_vecf_decrement ( Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_Matrix_f *gan_vecf_outer_s ( const Gan_Vector_f *x, Gan_Vector_f *y );

 Gan_SquMatrix_f *gan_vecf_outer_sym_s ( const Gan_Vector_f *x );

 float gan_vecf_sqrlen ( const Gan_Vector_f *x );

 Gan_Bool gan_vecf_same_size ( const Gan_Vector_f *x, const Gan_Vector_f *y );

 size_t gan_vecf_data_size ( unsigned long rows );

 Gan_Vector_f *gan_vecf_fscanf_s ( FILE *fp, const char *prefix,
                                  int prefix_len );

 Gan_Vector_f *gan_vecf_fread_s ( FILE *fp, gan_uint32 *magic_number );

#undef Gan_Matrix_f
#undef Gan_SquMatrix_f

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

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _GAN_VECF_GEN_H */

---