NAME

get_matrix_from_matrix_vector - Concatenates the matrices in a matrix vector

SYNOPSIS

#include "m/m_mat_vector.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_matrix_from_matrix_vector
(
	Matrix **mpp,
	const Matrix_vector *mvp
);

DESCRIPTION

This routine takes the matrices in a matrix vector and forms one matrix consisting of those matrices stacked on top of each other. The first argument is the adress of the target matrix. If the target matrix itself is null, then a matrix of the appropriate size is created. If the target matrix is the wrong size, it is resized. Finally, if it is the right size, then the storage is recycled, as is. The matrix array may contain any number of NULL matrices. If there are only NULL matrices, or if num_matrices is zero, then the target matrix is freed and set to NULL.

RETURNS

NO_ERROR on success and ERROR on failure This routine will only fail if storage allocation fails.

DISCLAIMER

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

AUTHOR

Kobus Barnard

DOCUMENTER