NAME

ow_scale_vector_by_mean_2 - 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 ow_scale_vector_by_mean_2
(
	Vector *vp,
	double *scale_factor_ptr
);

PARAMETERS

Vector *vp: Pointer to input Vector. Contents overwritten.
double *scale_factor_ptr: Optional return of scaling

DESCRIPTION

Scales the contents of the input vector "vp" such that the vector mean is 1. Places the result back in "vp", overwriting it's original contents. If "vp" is NULL, then this routine simply returns NO_ERROR. The argument scale_factor_ptr can be used to return the scale factor used to normalize the vector. Set it to NULL if you are not interested.

RETURNS

NO_ERROR on success, ERROR on failure.

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