pdsmatrix.h

/*
 * pdsmatrix.h
 * 
 * Copyright 2011 Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 */

#ifndef __PDSMATRIX_H__
#define __PDSMATRIX_H__

#ifdef __cplusplus
extern "C" {
#endif 

#include <stdio.h>
#include <stdlib.h>
#include <pds/pdsraglobal.h>
#include <pds/pdsvector.h>
#include <pds/pdsregionrect.h>

#ifndef PDS_OK

        #define PDS_OK 1
#endif

#ifndef PDS_WRONG

        #define PDS_WRONG 0
#endif



typedef struct 
{
        PdsRaReal **M;
        PdsRaNatural Nlin;
        PdsRaNatural Ncol;
}PdsMatrix;

PdsMatrix *pds_matrix_new(PdsRaNatural Nlin,PdsRaNatural Ncol);


PdsMatrix *pds_matrix_new_rand(PdsRaNatural Nlin,PdsRaNatural Ncol);

PdsMatrix *pds_matrix_new_matrix(const PdsMatrix *MatSrc);


PdsMatrix *pds_matrix_new_load_data(const char* datafile);


int pds_matrix_copy_matrix(PdsMatrix *Matrix,PdsRaNatural X1,PdsRaNatural Y1,const PdsMatrix *MatSrc,PdsRaNatural X2,PdsRaNatural Y2);


int pds_matrix_copy_vector_col(PdsMatrix *Matrix,const PdsVector *VecSrc,PdsRaNatural col);


int pds_matrix_copy_vector_lin(PdsMatrix *Matrix,const PdsVector *VecSrc,PdsRaNatural lin);


int pds_matrix_copy_identity(PdsMatrix *Matrix,PdsRaNatural X,PdsRaNatural Y,PdsRaReal Val);


int pds_matrix_copy_region_to_region(PdsMatrix *M1,PdsRegionRect R1,const PdsMatrix *M0,PdsRegionRect R0);


int pds_matrix_init_identity(PdsMatrix *Matrix,PdsRaReal Val);


int pds_matrix_init_matrix(PdsMatrix *Matrix,const PdsMatrix *MatSrc);


int pds_matrix_init_value(PdsMatrix *Matrix,PdsRaReal Val);

int pds_matrix_init_rand(PdsMatrix *Matrix);

int pds_matrix_init_region(PdsMatrix *Matrix,PdsRegionRect R,PdsRaReal val);



int pds_matrix_add_identity(PdsMatrix *Matrix,PdsRaReal Val);


int pds_matrix_add_matrix(PdsMatrix *Matrix,const PdsMatrix *MatSrc);


int pds_matrix_add_value(PdsMatrix *Matrix,PdsRaReal Val);


int pds_matrix_sub_matrix(PdsMatrix *Matrix,const PdsMatrix *MatSrc);


int pds_matrix_mul_matrix_elements(PdsMatrix *Matrix,const PdsMatrix *MatSrc);


int pds_matrix_mul_matrix(PdsMatrix *Matrix,const PdsMatrix *MatSrc1,const PdsMatrix *MatSrc2);


PdsMatrix *pds_matrix_mul_matrix_new(const PdsMatrix *MatSrc1,const PdsMatrix *MatSrc2);


int pds_matrix_mul_vector(PdsVector *A,const PdsMatrix *M,const PdsVector *V);


PdsVector *pds_matrix_mul_vector_new(const PdsMatrix *M,const PdsVector *V);


int pds_matrix_mul_value(PdsMatrix *Matrix,PdsRaReal Val);


PdsMatrix *pds_matrix_transpose_new(const PdsMatrix *M);


int pds_matrix_transpose(PdsMatrix *Mt,const PdsMatrix *M);

int pds_matrix_inverse_matrix(const PdsMatrix *Matrix, PdsMatrix *MatInv);


PdsMatrix *pds_matrix_inverse_matrix_new(const PdsMatrix *Matrix);



PdsMatrix *pds_matrix_mtm_new(const PdsMatrix *M);


PdsMatrix *pds_matrix_mtm_ai_new(const PdsMatrix *M,PdsRaReal Alpha);


int pds_matrix_linear_least_square(const PdsVector *U,const PdsMatrix *H,PdsVector *Z);


int pds_matrix_tikhonov_nolinear_least_square(const PdsVector *U,const PdsMatrix *J,const PdsVector *F,PdsRaReal Alpha,PdsVector *Z);


int pds_matrix_reduced_matrix(const PdsMatrix *Matrix, PdsMatrix *MatReduced);


int pds_matrix_mean(const PdsMatrix *Mat, PdsRaReal *mean);

int pds_matrix_std(const PdsMatrix *Mat, PdsRaReal *std);

int pds_matrix_std_and_mean(const PdsMatrix *Mat, PdsRaReal *std, PdsRaReal *mean);

int pds_matrix_corr_matrix(const PdsMatrix *M0,const PdsMatrix *M1, PdsRaReal *pcc);



int pds_matrix_mean_of_region(const PdsMatrix *Mat,PdsRegionRect Rin, PdsRaReal *mean);


int pds_matrix_std_of_region(const PdsMatrix *Mat,PdsRegionRect Rin, PdsRaReal *std);

int pds_matrix_std_and_mean_of_region(const PdsMatrix *Mat,PdsRegionRect Rin, PdsRaReal *std, PdsRaReal *mean);



int pds_matrix_corr_matrix_of_region(const PdsMatrix *M0,const PdsMatrix *M1,PdsRegionRect R0,PdsRegionRect R1, PdsRaReal *pcc);



int pds_matrix_swap_rows(PdsMatrix *Matrix, PdsRaNatural r1, PdsRaNatural r2);


int pds_matrix_row_add_row_factor(PdsMatrix *Matrix, PdsRaNatural r1, PdsRaNatural r2, PdsRaReal factor);


int pds_matrix_row_mul_factor(PdsMatrix *Matrix, PdsRaNatural r1, PdsRaReal factor);


int pds_matrix_row_div_factor(PdsMatrix *Matrix, PdsRaNatural r1, PdsRaReal factor);



int pds_matrix_printf(const PdsMatrix *Matrix);


int pds_matrix_fprintf(const PdsMatrix *Matrix,FILE *fd);


int pds_matrix_fscanf(PdsMatrix *Matrix, FILE *fd);


int pds_matrix_fwrite(PdsMatrix *Matrix, FILE *fd);


int pds_matrix_fread(PdsMatrix *Matrix, FILE *fd);



int pds_matrix_save_rgb_bmp(const PdsMatrix *R,const PdsMatrix *G,const PdsMatrix *B,const char *bmpfilename);


int pds_matrix_save_grayscale_bmp(const PdsMatrix *Mat,const char *bmpfilename);


int pds_matrix_save_bmp_with_colormap(const PdsMatrix *Mat,const char *bmpfilename,const unsigned char colormap[256][3]);


int pds_matrix_octave_surf(const PdsMatrix *M,const char *labelx,const char *labely,const char *labelz,const char *octfile,const char *imgfile);



int pds_matrix_get_value(const PdsMatrix *Matrix, PdsRaNatural x,PdsRaNatural y, PdsRaReal *m);

int pds_matrix_get_nlines(const PdsMatrix *Matrix, PdsRaNatural *Nlines);


int pds_matrix_get_ncolumns(const PdsMatrix *Matrix, PdsRaNatural *Ncolumns);

int pds_matrix_get_region_rect(const PdsMatrix *Mat,PdsRegionRect *R);


int pds_matrix_get_min_value(const PdsMatrix *Matrix, PdsRaReal *m);


int pds_matrix_get_min_value_and_pos(const PdsMatrix *Matrix, PdsRaReal *m,PdsRaNatural *lin,PdsRaNatural *col);


int pds_matrix_get_max_value(const PdsMatrix *Matrix, PdsRaReal *m);


int pds_matrix_get_max_value_and_pos(const PdsMatrix *Matrix, PdsRaReal *m,PdsRaNatural *lin,PdsRaNatural *col);


#define PDS_MSET(Matrix,X,Y,m) pds_matrix_set_value(Matrix,X,Y,m)

int pds_matrix_set_value(PdsMatrix *Matrix, PdsRaNatural x,PdsRaNatural y,PdsRaReal m);



int pds_matrix_is_equal (PdsMatrix *M1,PdsMatrix *M2);

int pds_matrix_is_quasiequal (PdsMatrix *M1,PdsMatrix *M2,double u);


int pds_matrix_is_diagonal (PdsMatrix *M1);


int pds_matrix_is_quasidiagonal (PdsMatrix *M1,double u);

int pds_matrix_is_symetric (PdsMatrix *M1);

int pds_matrix_is_antisymetric (PdsMatrix *M1);



void pds_matrix_free(PdsMatrix *Matrix);


void pds_matrix_destroy(PdsMatrix **Matrix);


#ifdef __cplusplus
}
#endif 

#endif