NAME

ow_scale_vector_by_sum - 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 ow_scale_vector_by_sum(Vector *vp);

PARAMETERS

Vector *vp
Pointer to input Vector. Contents overwritten.

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 back in "vp", and it's original contents are overwritten. If "vp" is NULL, then this routine simply returns NO_ERROR.

RETURNS

NO_ERROR on success, ERROR on failure.

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

SEE ALSO

normalize_vector , scale_vector_by_sum , scale_vector_by_mean , scale_vector_by_max_abs , scale_vector_by_max , scale_vector_by_magnitude , ow_normalize_vector , silent_ow_scale_vector_by_sum , safe_ow_scale_vector_by_sum , safe_ow_scale_vector_by_sum_2 , ow_scale_vector_by_mean , ow_scale_vector_by_max_abs , ow_scale_vector_by_max , ow_scale_vector_by_magnitude , normalize_vector_2 , scale_vector_by_sum_2 , scale_vector_by_mean_2 , scale_vector_by_max_abs_2 , scale_vector_by_max_2 , scale_vector_by_magnitude_2 , ow_normalize_vector_2 , ow_scale_vector_by_sum_2 , ow_scale_vector_by_mean_2 , ow_scale_vector_by_max_abs_2 , ow_scale_vector_by_max_2 , ow_scale_vector_by_magnitude_2 , vector_magnitude , max_abs_vector_element , min_vector_element , max_vector_element , get_min_vector_element , get_max_vector_element , max_thresh_vector , min_thresh_vector , ow_max_thresh_vector , ow_min_thresh_vector , ow_normalize_log_prob_vp , ow_exp_scale_by_sum_log_vector