NAME

scale_vector_by_mean - Scales a vector such that it's mean value is 1

SYNOPSIS

#include "m/m_vec_norm.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 scale_vector_by_mean
(
	Vector **target_vpp,
	const Vector *vp
);

PARAMETERS

Vector **target_vpp: Double pointer to output Vector.
const Vector *vp: Pointer to input Vector.

DESCRIPTION

Scales the contents of the input vector "vp" such that the vector mean is 1. Places the result in "target_vpp", leaving the input vector untouched. The mean must be positive, and not too close to zero, otherwise ERROR is returned, and an appropriate error message is set. If "vp" is NULL, then "*target_vpp" becomes NULL also (and its contents are freed if it has any), and NO_ERROR is returned.

RETURNS

NO_ERROR on success, ERROR on failure.

ow_scale_vector_by_mean_2

DISCLAIMER

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

AUTHOR

Kobus Barnard

DOCUMENTER

Lindsay Martin and Kobus Barnard