NAME

scale_vector_by_sum_2 - Scales a vector so that the sum of elements 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_sum_2
(
	Vector **target_vpp,
	const Vector *vp,
	double *scale_factor_ptr
);

PARAMETERS

Vector **target_vpp: Double pointer to output Vector.
const Vector *vp: Pointer to input Vector.
double *scale_factor_ptr: Optional return of scaling

DESCRIPTION

Scales the the elements of the input vector "vp" so that the sum of it's elements equal 1. The scaled result is placed in "target_vpp", and the original vector is untouched. 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. The sum 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_sum_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