NAME

get_rms_relative_col_error - Returns the RMS relative error of rows and/or entire matrices

SYNOPSIS

#include "m/m_mat_error.h"

Example compile flags (system dependent):
  -DLINUX_X86_64 -DLINUX_X86_64_OPTERON  -DGNU_COMPILER 
   -I/home/kobus/include
   -L/home/kobus/misc/load/linux_x86_64_opteron -L/usr/lib/x86_64-linux-gnu
  -lKJB                               -lfftw3  -lgsl -lgslcblas -ljpeg  -lSVM -lstdc++                    -lpthread -lSLATEC -lg2c    -lacml -lacml_mv -lblas -lg2c      -lncursesw 


int get_rms_relative_col_error
(
	Vector **result_vpp,
	const Matrix *first_mp,
	const Matrix *second_mp,
	double *error_ptr
);

DESCRIPTION

This routine calculates the RMS relative error of the columns of two dimension compatable matrices and/or the overall RMS relative error. If result_vpp is not NULL, then the RMS relative error of corresponding column are put into (*result_vpp) which is created or resized as needed. If error_ptr is not NULL, then the RMS relative error of the entire matrix is put into (*error_ptr). The relative error of corresponding pairs of number is computed by their difference normalized by their average.

RETURNS

NO_ERROR on success, and ERROR on failure (not very likely--currently impossible). Note that sending in matrices with incompatable dimensions is regarded as a bug. (See set_bug(3)).

DISCLAIMER

This software is not adequatedly tested. It is recomended that results are checked independantly where appropriate.

AUTHOR

Kobus Barnard

DOCUMENTER