NAME

write_matrix_vector - Writes a matrix vector to a file specified by name

SYNOPSIS

#include "m/m_mat_io.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 write_matrix_vector
(
	const Matrix_vector *mvp,
	const char *file_name
);

DESCRIPTION

This routine outputs a matrix vector to a file specified by the file name. "file_name" is a pointer to a character array containing the name of the file to write the matrix contents to. If "file_name" is NULL or equal to '\0', output is directed to STDOUT. Otherwise, the file is created or the existing copy is overwritten. "mvp" is a pointer to the Matrix_vector whose contents are to be written. If it is NULL, then this routine will write a matrix vector with the number of matrices set to zero, which will read in as NULL with the analogous read routine. The output begins with a line specifying the number of matrices as follows:

         #! num_matrices=999

Each matrix is proceeded by line indicating its size using the following format:

         #! rows=10 cols=10

A NULL matrix will be indicated by

         #! rows=0 cols=0

The output format of the numbers depends on the magnitude of the maximum value in the matrix. If the maximum is < 0.01 or greater than 10000, the data is written in exponential format according to the format string "%10.3e". Otherwise the matrix elements are written in fixed format according to "8.4f".

RETURNS

NO_ERROR on success, or ERROR on a file write or close error.

DISCLAIMER

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

AUTHOR

Kobus Barnard

DOCUMENTER