NAME

concat_matrices_vertically - Concatenates matrices vertically

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 concat_matrices_vertically
(
	Matrix **mpp,
	int num_matrices,
	const Matrix *matrix_list[]
);

DESCRIPTION

This routine takes an array of matrices and forms one matrix consisting of those matrices stacked on top of each other. The first argument is the address 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. All non-null matrices must have the same number of columns.

RETURNS

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

NOTE

More often then not, one wants to concatentate the matrices in a matrix vector. The routine get_matrix_from_matrix_vector() is much more convenient for that.

RELATED

get_matrix_from_matrix_vector

DISCLAIMER

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

AUTHOR

Kobus Barnard

DOCUMENTER

Kobus Barnard

SEE ALSO

get_target_matrix_vector , free_matrix_vector , count_non_null_matrix_vector_matrices , matrix_vectors_are_comparable , is_matrix_vector_consistent , average_matrices , std_dev_matrices , get_target_matrix_vector_vector , free_matrix_vector_vector , interleave_matrix_rows , interleave_matrix_cols , concat_matrices_horizontally , get_matrix_from_matrix_vector , get_matrix_from_matrix_vector_with_col_selection , get_matrix_vector_from_matrix , get_matrix_vector_from_matrix_2 , allocate_2D_mp_array , free_2D_mp_array , free_2D_mp_array_and_matrices