matf_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_MATF_GEN_H
#define _GAN_MATF_GEN_H

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

#ifdef __cplusplus
extern "C" {
#endif

struct Gan_SquMatrix_f;

typedef struct Gan_Matrix_f
{
   /* row and column dimensions of matrix */
   unsigned long rows, cols;

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

   /* allocated size of matrix (number of float's) */
   size_t data_size;

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

   /* flag indicating whether matrix structure was dynamically allocated */
   Gan_Bool struct_alloc;
} Gan_Matrix_f;

#define GAN_MATRIXF_STRUCT_DEFINED

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

 void gan_matf_free ( Gan_Matrix_f *A );
 Gan_Matrix_f *gan_matf_set_dims ( Gan_Matrix_f *A,
                                  unsigned long rows, unsigned long cols );
 Gan_Matrix_f *gan_matf_fill_va ( Gan_Matrix_f *A,
                                 unsigned long rows, unsigned long cols, ... );
 Gan_Matrix_f *gan_matf_fill_vap ( Gan_Matrix_f *A,
                                  unsigned long rows, unsigned long cols,
                                  va_list *aptr );
 Gan_Matrix_f *gan_matf_fill_const_q ( Gan_Matrix_f *A,
                                      unsigned long rows, unsigned long cols,
                                      float value );
 Gan_Bool gan_matf_read_va ( const Gan_Matrix_f *A,
                            unsigned long rows, unsigned long cols, ... );
 Gan_Matrix_f *gan_matf_copy_q ( const Gan_Matrix_f *A, Gan_Matrix_f *B );
 Gan_Matrix_f *gan_matf_scale_q ( Gan_Matrix_f *A, float a, Gan_Matrix_f *B );
 Gan_Matrix_f *gan_matf_divide_q ( Gan_Matrix_f *A, float a, Gan_Matrix_f *B );
 Gan_Matrix_f *gan_matf_tpose_q ( Gan_Matrix_f *A, Gan_Matrix_f *B );
 Gan_Bool gan_matf_is_zero ( Gan_Matrix_f *A );
 Gan_Matrix_f *gan_matf_insertsym ( Gan_Matrix_f *A,
                                   unsigned long rA, unsigned long cA,
                                   const struct Gan_SquMatrix_f *B,
                                   unsigned long rB, unsigned long cB,
                                   unsigned long rows , unsigned long cols );
 void gan_matf_free_va ( Gan_Matrix_f *A, ... );
 Gan_Matrix_f *gan_matf_extract_q ( const Gan_Matrix_f *A,
                                   unsigned long r0,   unsigned long c0,
                                   unsigned long rows, unsigned long cols,
                                   Gan_Matrix_f *B );
 float gan_matf_sumsqr ( const Gan_Matrix_f *A );
 float gan_matf_Fnorm ( const Gan_Matrix_f *A );
 Gan_Matrix_f *gan_matf_invert_q ( const Gan_Matrix_f *A, Gan_Matrix_f *B );
 Gan_Bool gan_matf_fprint ( FILE *fp, const Gan_Matrix_f *A, const char *prefix,
                           unsigned indent, const char *fmt );
 Gan_Matrix_f *gan_matf_fscanf_q ( FILE *fp, Gan_Matrix_f *A,
                                  char *prefix, int prefix_len );
 Gan_Bool gan_matf_fwrite ( FILE *fp, const Gan_Matrix_f *A, gan_uint32 magic_number );
 Gan_Matrix_f *gan_matf_fread_q ( FILE *fp, Gan_Matrix_f *A,
                                 gan_uint32 *magic_number );

#define Gan_SquMatrix_f struct Gan_SquMatrix_f

 Gan_Matrix_f *gan_matf_alloc ( unsigned long rows, unsigned long cols );

 Gan_Matrix_f *gan_matf_form ( Gan_Matrix_f *A,
                              unsigned long rows, unsigned long cols );

 Gan_Matrix_f *gan_matf_form_data ( Gan_Matrix_f *A,
                                   unsigned long rows, unsigned long cols,
                                   float *data, size_t data_size );

 Gan_Bool gan_matf_set_el ( Gan_Matrix_f *A,
                           unsigned i, unsigned j, float value);

 float gan_matf_get_el ( const Gan_Matrix_f *A, unsigned i, unsigned j );

 Gan_Bool gan_matf_inc_el ( Gan_Matrix_f *A,
                           unsigned i, unsigned j, float value);

 Gan_Bool gan_matf_dec_el ( Gan_Matrix_f *A,
                           unsigned i, unsigned j, float value);

 Gan_Bool gan_matf_print ( const Gan_Matrix_f *A,
                          const char *prefix, int indent, const char *fmt );

 Gan_Matrix_f *gan_matf_fill_const_s ( unsigned long rows, unsigned long cols,
                                      float value );

 Gan_Matrix_f *gan_matf_fill_zero_q ( Gan_Matrix_f *A,
                                     unsigned long rows, unsigned long cols );

 Gan_Matrix_f *gan_matf_fill_zero_s ( unsigned long rows, unsigned cols );

 Gan_Matrix_f *gan_matf_copy_s ( const Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_scale_s ( Gan_Matrix_f *A, float a );

 Gan_Matrix_f *gan_matf_scale_i ( Gan_Matrix_f *A, float a );

 Gan_Matrix_f *gan_matf_divide_s ( Gan_Matrix_f *A, float a );

 Gan_Matrix_f *gan_matf_divide_i ( Gan_Matrix_f *A, float a );

 Gan_Matrix_f *gan_matf_negate_q ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_negate_s ( Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_negate_i ( Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_tpose_s ( Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_tpose_i ( Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_add_q ( Gan_Matrix_f *A, Gan_Matrix_f *B,
                               Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matf_add_s ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_add_i1 ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_add_i2 ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_increment ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_addT_q ( Gan_Matrix_f *A, Gan_Matrix_f *B,
                                Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matf_addT_s ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_incrementT ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matf_add_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                      Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matf_add_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matf_addT_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                       Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matf_addT_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matTf_add_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                       Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matTf_add_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matTf_addT_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                        Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matTf_addT_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matf_saddT_sym_q ( const Gan_Matrix_f *A, Gan_SquMatrix_f *B );

 Gan_SquMatrix_f *gan_matf_saddT_sym_s ( const Gan_Matrix_f *A );

 Gan_SquMatrix_f *gan_matTf_sadd_sym_q ( const Gan_Matrix_f *A, Gan_SquMatrix_f *B );

 Gan_SquMatrix_f *gan_matTf_sadd_sym_s ( const Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_sub_q ( Gan_Matrix_f *A, Gan_Matrix_f *B, Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matf_sub_s ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_sub_i1 ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_sub_i2 ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_decrement ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_subT_q ( Gan_Matrix_f *A, Gan_Matrix_f *B,
                                Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matf_subT_s ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_decrementT ( Gan_Matrix_f *A, Gan_Matrix_f *B );

 Gan_Vector_f *gan_matf_multv_q ( const Gan_Matrix_f *A, const Gan_Vector_f *x,
                                 Gan_Vector_f *y );

 Gan_Vector_f *gan_matf_multv_s ( const Gan_Matrix_f *A, const Gan_Vector_f *x );

 Gan_Vector_f *gan_matTf_multv_q ( const Gan_Matrix_f *A, const Gan_Vector_f *x,
                                  Gan_Vector_f *y );

 Gan_Vector_f *gan_matTf_multv_s ( const Gan_Matrix_f *A, const Gan_Vector_f *x );

 Gan_Matrix_f *gan_matf_rmult_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                 Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matf_rmult_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_rmultT_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                  Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matf_rmultT_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matTf_rmult_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                  Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matTf_rmult_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matTf_rmultT_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                   Gan_Matrix_f *C );

 Gan_Matrix_f *gan_matTf_rmultT_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matf_rmult_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                        Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matf_rmult_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matf_rmultT_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                         Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matf_rmultT_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matTf_rmult_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                         Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matTf_rmult_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matTf_rmultT_sym_q ( const Gan_Matrix_f *A, const Gan_Matrix_f *B,
                                          Gan_SquMatrix_f *C );

 Gan_SquMatrix_f *gan_matTf_rmultT_sym_s ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_SquMatrix_f *gan_matf_srmultT_q ( const Gan_Matrix_f *A, Gan_SquMatrix_f *B );

 Gan_SquMatrix_f *gan_matf_srmultT_s ( const Gan_Matrix_f *A );

 Gan_SquMatrix_f *gan_matf_slmultT_q ( const Gan_Matrix_f *A, Gan_SquMatrix_f *B );

 Gan_SquMatrix_f *gan_matf_slmultT_s ( const Gan_Matrix_f *A );

 Gan_Matrix_f *gan_matf_invert_s ( const Gan_Matrix_f *A ) /* input matrix */;

 Gan_Bool gan_matf_same_dims ( const Gan_Matrix_f *A, const Gan_Matrix_f *B );

 Gan_Matrix_f *gan_matf_insert ( Gan_Matrix_f *A,
                                unsigned long rA, unsigned long cA,
                                const Gan_Matrix_f *B,
                                unsigned long rB,   unsigned long cB,
                                unsigned long rows, unsigned long cols )
;

 Gan_Matrix_f *gan_matf_insertT ( Gan_Matrix_f *A,
                                 unsigned long rA, unsigned long cA,
                                 const Gan_Matrix_f *B,
                                 unsigned long rB,   unsigned long cB,
                                 unsigned long rows, unsigned long cols );

 Gan_Matrix_f *gan_matf_insertv ( Gan_Matrix_f *A,
                                 unsigned long rA, unsigned long cA,
                                 const Gan_Vector_f *x, unsigned long rx,
                                 unsigned long rows );

 Gan_Matrix_f *gan_matf_insertvT ( Gan_Matrix_f *A,
                                  unsigned long rA, unsigned long cA,
                                  const Gan_Vector_f *x, unsigned long rx,
                                  unsigned long cols );

 Gan_Bool gan_matf_test_dims ( const Gan_Matrix_f *A, unsigned long rows,
                                               unsigned long cols );

 size_t gan_matf_data_size ( unsigned long rows, unsigned long cols );

 Gan_Matrix_f *gan_matf_extract_s ( const Gan_Matrix_f *A,
                                   unsigned long r0,   unsigned long c0,
                                   unsigned long rows, unsigned long cols );

 Gan_Matrix_f *gan_matf_fscanf_s ( FILE *fp, const char *prefix,
                                  int prefix_len );

 Gan_Matrix_f *gan_matf_fread_s ( FILE *fp, gan_uint32 *magic_number );

#undef Gan_SquMatrix_f

/* not user functions */
 Gan_Matrix_f *gan_matf_form_gen ( Gan_Matrix_f *A,
                                  unsigned long rows, unsigned long cols,
                                  float *data, size_t data_size );
 Gan_Bool gan_matf_realloc_gen ( Gan_Matrix_f *A,
                                unsigned long rows, unsigned long cols );
 Gan_Matrix_f *gan_matf_add_gen ( Gan_Matrix_f *A, Gan_TposeFlag A_tr,
                                 Gan_Matrix_f *B, Gan_TposeFlag B_tr,
                                 Gan_Matrix_f *C );
 struct Gan_SquMatrix_f *gan_matf_add_sym_gen (
    const Gan_Matrix_f *A, Gan_TposeFlag A_tr,
    const Gan_Matrix_f *B, Gan_TposeFlag B_tr,
    struct Gan_SquMatrix_f *C );
 Gan_Matrix_f *gan_matf_sub_gen ( Gan_Matrix_f *A, Gan_TposeFlag A_tr,
                                 Gan_Matrix_f *B, Gan_TposeFlag B_tr,
                                 Gan_Matrix_f *C );
 Gan_Vector_f *gan_matf_multv_gen ( const Gan_Matrix_f *A, Gan_TposeFlag A_tr,
                                   const Gan_Vector_f *x, Gan_Vector_f *y );
 Gan_Matrix_f *gan_matf_rmult_gen ( const Gan_Matrix_f *A, Gan_TposeFlag A_tr,
                                   const Gan_Matrix_f *B, Gan_TposeFlag B_tr,
                                   Gan_Matrix_f *C );
 struct Gan_SquMatrix_f *gan_matf_rmult_sym_gen (
    const Gan_Matrix_f *A, Gan_TposeFlag A_tr,
    const Gan_Matrix_f *B, Gan_TposeFlag B_tr,
    struct Gan_SquMatrix_f *C );
 Gan_Matrix_f *gan_matf_insert_gen ( Gan_Matrix_f *A,
                                    unsigned long rA, unsigned long cA,
                                    const Gan_Matrix_f *B, Gan_TposeFlag B_tr,
                                    unsigned long rB, unsigned long cB,
                                    unsigned long rows , unsigned long cols );
 Gan_Matrix_f *gan_matf_insertv_gen ( Gan_Matrix_f *A,
                                     unsigned long rA, unsigned long cA,
                                     const struct Gan_Vector_f *x,
                                     Gan_TposeFlag x_tr,
                                     unsigned long rx, unsigned long size );

#ifndef NDEBUG
 void gan_matf_db ( const Gan_Matrix_f *A ); /* for use in a debugger */
#endif

#define gan_matf_realloc(A,rows,cols) gan_matf_realloc_gen(A,rows,cols)

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _GAN_MATF_GEN_H */

---