octave_packages/geometry-1.5.0/geom2d/normalizeVector.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2004-2011, David Legland <david.legland@grignon.inra.fr>
   3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
   4 %%
   5 %% All rights reserved.
   6 %% (simplified BSD License)
   7 %%
   8 %% Redistribution and use in source and binary forms, with or without
   9 %% modification, are permitted provided that the following conditions are met:
  10 %%
  11 %% 1. Redistributions of source code must retain the above copyright notice, this
  12 %%    list of conditions and the following disclaimer.
  13 %%
  14 %% 2. Redistributions in binary form must reproduce the above copyright notice,
  15 %%    this list of conditions and the following disclaimer in the documentation
  16 %%    and/or other materials provided with the distribution.
  17 %%
  18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 %% POSSIBILITY OF SUCH DAMAGE.
  29 %%
  30 %% The views and conclusions contained in the software and documentation are
  31 %% those of the authors and should not be interpreted as representing official
  32 %% policies, either expressed or implied, of copyright holder.
  33
  34 %% -*- texinfo -*-
  35 %% @deftypefn {Function File} {@var{vn} = } normalizeVector (@var{v})
  36 %% Normalize a vector to have norm equal to 1
  37 %%
  38 %% Returns the normalization of vector @var{v}, such that ||@var{v}|| = 1.
  39 %% @var{v} can be either a row or a column vector.
  40 %%
  41 %% When @var{v} is a MxN array, normalization is performed for each row of the
  42 %% array.
  43 %%
  44 %%   Example:
  45 %%
  46 %% @example
  47 %%   vn = normalizeVector([3 4])
  48 %%   vn =
  49 %%       0.6000   0.8000
  50 %%   vectorNorm(vn)
  51 %%   ans =
  52 %%       1
  53 %% @end example
  54 %%
  55 %% @seealso{vectors2d, vectorNorm}
  56 %% @end deftypefn
  57
  58 function vn = normalizeVector(v)
  59
  60   dim = size(v);
  61
  62   if dim(1)==1 || dim(2)==1
  63       vn = v / sqrt(sum(v.^2));
  64   else
  65       %same as: vn = v./repmat(sqrt(sum(v.*v, 2)), [1 dim(2)]);
  66       vn = bsxfun(@rdivide, v, sqrt(sum(v.^2, 2)));
  67   end
  68
  69 endfunction
  70
  71 %!assert (1,vectorNorm (normalizeVector ([3 4])))
  72