NAME

write_matrix - Writes a matrix 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
(
	const Matrix *mp,
	const char *file_name
);

DESCRIPTION

This routine outputs a Matrix to a file specified by the input 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 the first character is null, then output is directed to STDOUT. Otherwise, the file is created or the existing copy is overwritten. "mp" is a pointer to the Matrix whose contents are to be written. If the matrix is NULL, then this routine is a NOP. The output format 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.

WARNING

This routine does not write at full precision! For full precision use either write_matrix_full_precision() or write_raw_matrix().

RELATED

fp_write_matrix, read_matrix

DISCLAIMER

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

AUTHOR

Kobus Barnard

DOCUMENTER

Lindsay Martin

SEE ALSO

read_matrix_from_config_file , read_matrix , fp_read_matrix , fp_read_raw_matrix , fp_read_matrix_with_header , fp_read_formatted_matrix , read_matrix_by_rows , fp_read_matrix_by_rows , read_matrix_by_cols , fp_read_matrix_by_cols , fp_ow_read_formatted_matrix , fp_ow_read_matrix_by_rows , fp_ow_read_matrix_by_cols , write_matrix_2 , fp_write_matrix , fp_write_matrix_2 , write_matrix_with_header , fp_write_matrix_with_header , write_matrix_full_precision , fp_write_matrix_full_precision , write_matrix_rows , fp_write_matrix_rows , write_matrix_cols , fp_write_matrix_cols , write_matrix_vector , fp_write_matrix_vector , write_matrix_vector_full_precision , fp_write_matrix_vector_full_precision , fp_write_matrix_with_title , fp_write_matrix_full_precision_with_title , write_raw_matrix , fp_write_raw_matrix , read_matrix_vector , fp_read_matrix_vector , fp_read_raw_matrix_vector , fp_read_matrix_vector_with_headers , write_raw_matrix_vector , fp_write_raw_matrix_vector , fp_write_raw_matrix_vector_header