NAME

scale_vector_by_magnitude_2 - Scales a vector such that it's magnitude 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_magnitude_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 contents of the input vector "vp" such that the vector magnitude is 1. Places the result in "target_vpp", leaving the input vector 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. 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.

RELATED

ow_scale_vector_by_magnitude_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

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_sum , 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 , 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