mat_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_MAT_GEN_H
#define _GAN_MAT_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;

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

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

   /* allocated size of matrix (number of double'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;

#define GAN_MATRIX_STRUCT_DEFINED

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

 void gan_mat_free ( Gan_Matrix *A );
 Gan_Matrix *gan_mat_set_dims ( Gan_Matrix *A,
                               unsigned long rows, unsigned long cols );
 Gan_Matrix *gan_mat_fill_va ( Gan_Matrix *A,
                              unsigned long rows, unsigned long cols, ... );
 Gan_Matrix *gan_mat_fill_vap ( Gan_Matrix *A,
                               unsigned long rows, unsigned long cols,
                               va_list *aptr );
 Gan_Matrix *gan_mat_fill_const_q ( Gan_Matrix *A,
                                   unsigned long rows, unsigned long cols,
                                   double value );
 Gan_Bool gan_mat_read_va ( const Gan_Matrix *A,
                           unsigned long rows, unsigned long cols, ... );
 Gan_Matrix *gan_mat_copy_q ( const Gan_Matrix *A, Gan_Matrix *B );
 Gan_Matrix *gan_mat_scale_q ( Gan_Matrix *A, double a, Gan_Matrix *B );
 Gan_Matrix *gan_mat_divide_q ( Gan_Matrix *A, double a, Gan_Matrix *B );
 Gan_Matrix *gan_mat_tpose_q ( Gan_Matrix *A, Gan_Matrix *B );
 Gan_Matrix *gan_mat_insertsym ( Gan_Matrix *A,
                                unsigned long rA, unsigned long cA,
                                const struct Gan_SquMatrix *B,
                                unsigned long rB, unsigned long cB,
                                unsigned long rows , unsigned long cols );
 Gan_Bool gan_mat_is_zero ( Gan_Matrix *A );
 void gan_mat_free_va ( Gan_Matrix *A, ... );
 Gan_Matrix *gan_mat_extract_q ( const Gan_Matrix *A,
                                unsigned long r0,   unsigned long c0,
                                unsigned long rows, unsigned long cols,
                                Gan_Matrix *B );
 double gan_mat_sumsqr ( const Gan_Matrix *A );
 double gan_mat_Fnorm ( const Gan_Matrix *A );
 Gan_Matrix *gan_mat_invert_q ( const Gan_Matrix *A, Gan_Matrix *B );
 Gan_Bool gan_mat_fprint ( FILE *fp, const Gan_Matrix *A, const char *prefix,
                          unsigned indent, const char *fmt );
 Gan_Matrix *gan_mat_fscanf_q ( FILE *fp, Gan_Matrix *A,
                               char *prefix, int prefix_len );
 Gan_Bool gan_mat_fwrite ( FILE *fp, const Gan_Matrix *A, gan_uint32 magic_number );
 Gan_Matrix *gan_mat_fread_q ( FILE *fp, Gan_Matrix *A,
                              gan_uint32 *magic_number );

#define Gan_SquMatrix struct Gan_SquMatrix

 Gan_Matrix *gan_mat_alloc ( unsigned long rows, unsigned long cols );

 Gan_Matrix *gan_mat_form ( Gan_Matrix *A,
                           unsigned long rows, unsigned long cols );

 Gan_Matrix *gan_mat_form_data ( Gan_Matrix *A,
                                unsigned long rows, unsigned long cols,
                                double *data, size_t data_size );

 Gan_Bool gan_mat_set_el ( Gan_Matrix *A, unsigned i, unsigned j, double value);

 double gan_mat_get_el ( const Gan_Matrix *A, unsigned i, unsigned j );

 Gan_Bool gan_mat_inc_el ( Gan_Matrix *A, unsigned i, unsigned j, double value);

 Gan_Bool gan_mat_dec_el ( Gan_Matrix *A, unsigned i, unsigned j, double value);

 Gan_Bool gan_mat_print ( const Gan_Matrix *A,
                         const char *prefix, int indent, const char *fmt );

 Gan_Matrix *gan_mat_fill_const_s ( unsigned long rows, unsigned long cols,
                                   double value );

 Gan_Matrix *gan_mat_fill_zero_q ( Gan_Matrix *A,
                                  unsigned long rows, unsigned long cols );

 Gan_Matrix *gan_mat_fill_zero_s ( unsigned long rows, unsigned cols );

 Gan_Matrix *gan_mat_copy_s ( const Gan_Matrix *A );

 Gan_Matrix *gan_mat_scale_s ( Gan_Matrix *A, double a );

 Gan_Matrix *gan_mat_scale_i ( Gan_Matrix *A, double a );

 Gan_Matrix *gan_mat_divide_s ( Gan_Matrix *A, double a );

 Gan_Matrix *gan_mat_divide_i ( Gan_Matrix *A, double a );

 Gan_Matrix *gan_mat_negate_q ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_negate_s ( Gan_Matrix *A );

 Gan_Matrix *gan_mat_negate_i ( Gan_Matrix *A );

 Gan_Matrix *gan_mat_tpose_s ( Gan_Matrix *A );

 Gan_Matrix *gan_mat_tpose_i ( Gan_Matrix *A );

 Gan_Matrix *gan_mat_add_q ( Gan_Matrix *A, Gan_Matrix *B, Gan_Matrix *C );

 Gan_Matrix *gan_mat_add_s ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_add_i1 ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_add_i2 ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_increment ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_addT_q ( Gan_Matrix *A, Gan_Matrix *B, Gan_Matrix *C );

 Gan_Matrix *gan_mat_addT_s ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_incrementT ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_SquMatrix *gan_mat_add_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                   Gan_SquMatrix *C );

 Gan_SquMatrix *gan_mat_add_sym_s ( const Gan_Matrix *A, Gan_Matrix *B );

 Gan_SquMatrix *gan_mat_addT_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                    Gan_SquMatrix *C );

 Gan_SquMatrix *gan_mat_addT_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_matT_add_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                    Gan_SquMatrix *C );

 Gan_SquMatrix *gan_matT_add_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_matT_addT_sym_q ( Gan_Matrix *A, Gan_Matrix *B,
                                     Gan_SquMatrix *C );

 Gan_SquMatrix *gan_matT_addT_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_mat_saddT_sym_q ( const Gan_Matrix *A, const Gan_SquMatrix *B );

 Gan_SquMatrix *gan_mat_saddT_sym_s ( const Gan_Matrix *A );

 Gan_SquMatrix *gan_matT_sadd_sym_q ( const Gan_Matrix *A, Gan_SquMatrix *B );

 Gan_SquMatrix *gan_matT_sadd_sym_s ( const Gan_Matrix *A );

 Gan_Matrix *gan_mat_sub_q ( Gan_Matrix *A, Gan_Matrix *B, Gan_Matrix *C );

 Gan_Matrix *gan_mat_sub_s ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_sub_i1 ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_sub_i2 ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_decrement ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_subT_q ( Gan_Matrix *A, Gan_Matrix *B,
                             Gan_Matrix *C );

 Gan_Matrix *gan_mat_subT_s ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Matrix *gan_mat_decrementT ( Gan_Matrix *A, Gan_Matrix *B );

 Gan_Vector *gan_mat_multv_q ( const Gan_Matrix *A, const Gan_Vector *x,
                              Gan_Vector *y );

 Gan_Vector *gan_mat_multv_s ( const Gan_Matrix *A, const Gan_Vector *x );

 Gan_Vector *gan_matT_multv_q ( const Gan_Matrix *A, const Gan_Vector *x,
                               Gan_Vector *y );

 Gan_Vector *gan_matT_multv_s ( const Gan_Matrix *A, const Gan_Vector *x );

 Gan_Matrix *gan_mat_rmult_q ( const Gan_Matrix *A, const Gan_Matrix *B, Gan_Matrix *C );

 Gan_Matrix *gan_mat_rmult_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_Matrix *gan_mat_rmultT_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                               Gan_Matrix *C );

 Gan_Matrix *gan_mat_rmultT_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_Matrix *gan_matT_rmult_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                               Gan_Matrix *C );

 Gan_Matrix *gan_matT_rmult_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_Matrix *gan_matT_rmultT_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                Gan_Matrix *C );

 Gan_Matrix *gan_matT_rmultT_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_mat_rmult_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                     Gan_SquMatrix *C );

 Gan_SquMatrix *gan_mat_rmult_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_mat_rmultT_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                      Gan_SquMatrix *C );

 Gan_SquMatrix *gan_mat_rmultT_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_matT_rmult_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                      Gan_SquMatrix *C );

 Gan_SquMatrix *gan_matT_rmult_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_matT_rmultT_sym_q ( const Gan_Matrix *A, const Gan_Matrix *B,
                                       Gan_SquMatrix *C );

 Gan_SquMatrix *gan_matT_rmultT_sym_s ( const Gan_Matrix *A, const Gan_Matrix *B );

 Gan_SquMatrix *gan_mat_srmultT_q ( const Gan_Matrix *A, const Gan_SquMatrix *B );

 Gan_SquMatrix *gan_mat_srmultT_s ( const Gan_Matrix *A );

 Gan_SquMatrix *gan_mat_slmultT_q ( const Gan_Matrix *A, Gan_SquMatrix *B );

 Gan_SquMatrix *gan_mat_slmultT_s ( const Gan_Matrix *A );

 Gan_Matrix *gan_mat_invert_s ( const Gan_Matrix *A );

 Gan_Bool gan_mat_same_dims ( const Gan_Matrix *A, const Gan_Matrix *B );

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

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

 Gan_Matrix *gan_mat_insertv ( Gan_Matrix *A,
                              unsigned long rA, unsigned long cA,
                              const Gan_Vector *x, unsigned long rx,
                              unsigned long rows );

 Gan_Matrix *gan_mat_insertvT ( Gan_Matrix *A,
                               unsigned long rA, unsigned long cA,
                               const Gan_Vector *x, unsigned long rx,
                               unsigned long cols );

 Gan_Bool gan_mat_test_dims ( const Gan_Matrix *A, unsigned long rows,
                                            unsigned long cols );

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

 Gan_Matrix *gan_mat_extract_s ( const Gan_Matrix *A,
                                unsigned long r0,   unsigned long c0,
                                unsigned long rows, unsigned long cols );

 Gan_Matrix *gan_mat_fscanf_s ( FILE *fp, const char *prefix, int prefix_len );

 Gan_Matrix *gan_mat_fread_s ( FILE *fp, gan_uint32 *magic_number );

#undef Gan_SquMatrix

/* not user functions */
 Gan_Matrix *gan_mat_form_gen ( Gan_Matrix *A,
                               unsigned long rows, unsigned long cols,
                               double *data, size_t data_size );
 Gan_Bool gan_mat_realloc_gen ( Gan_Matrix *A,
                               unsigned long rows, unsigned long cols );
 Gan_Matrix *gan_mat_add_gen ( Gan_Matrix *A, Gan_TposeFlag A_tr,
                              Gan_Matrix *B, Gan_TposeFlag B_tr,
                              Gan_Matrix *C );
 struct Gan_SquMatrix *gan_mat_add_sym_gen ( const Gan_Matrix *A, Gan_TposeFlag A_tr,
                                            const Gan_Matrix *B, Gan_TposeFlag B_tr,
                                            struct Gan_SquMatrix *C );
 Gan_Matrix *gan_mat_sub_gen ( Gan_Matrix *A, Gan_TposeFlag A_tr,
                              Gan_Matrix *B, Gan_TposeFlag B_tr,
                              Gan_Matrix *C );
 Gan_Vector *gan_mat_multv_gen ( const Gan_Matrix *A, Gan_TposeFlag A_tr,
                                const Gan_Vector *x, Gan_Vector *y );
 Gan_Matrix *gan_mat_rmult_gen ( const Gan_Matrix *A, Gan_TposeFlag A_tr,
                                const Gan_Matrix *B, Gan_TposeFlag B_tr,
                                Gan_Matrix *C );
 struct Gan_SquMatrix *gan_mat_rmult_sym_gen (const Gan_Matrix *A, Gan_TposeFlag A_tr,
                                             const Gan_Matrix *B, Gan_TposeFlag B_tr,
                                             struct Gan_SquMatrix *C );
 Gan_Matrix *gan_mat_insert_gen ( Gan_Matrix *A,
                                 unsigned long rA, unsigned long cA,
                                 const Gan_Matrix *B, Gan_TposeFlag B_tr,
                                 unsigned long rB, unsigned long cB,
                                 unsigned long rows , unsigned long cols );
 Gan_Matrix *gan_mat_insertv_gen ( Gan_Matrix *A,
                                  unsigned long rA, unsigned long cA,
                                  const struct Gan_Vector *x, Gan_TposeFlag x_tr,
                                  unsigned long rx, unsigned long size );

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

#define gan_mat_realloc(A,rows,cols) gan_mat_realloc_gen(A,rows,cols)

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _GAN_MAT_GEN_H */

---