octave_packages/geometry-1.5.0/geom2d/vectorNorm.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2007-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{nm} = } vectorNorm (@var{v})
  36 %% @deftypefnx {Function File} {@var{nm} = } vectorNorm (@var{v},@var{n})
  37 %% Compute norm of a vector, or of a set of vectors
  38 %%
  39 %% Without extra arguments, returns the euclidean norm of vector V.
  40 %% Optional argument @var{n} specifies the norm to use. N can be any value
  41 %% greater than 0.
  42 %% @table @samp
  43 %% @item  N=1
  44 %%   City lock norm.
  45 %% @item  N=2
  46 %%   Euclidean norm.
  47 %% @item N=inf
  48 %%   Compute max coord.
  49 %% @end table
  50 %%
  51 %%   When @var{v} is a MxN array, compute norm for each vector of the array.
  52 %%   Vector are given as rows. Result is then a Mx1 array.
  53 %%
  54 %%   Example
  55 %%
  56 %% @example
  57 %%   n1 = vectorNorm([3 4])
  58 %%   n1 =
  59 %%       5
  60 %%
  61 %%   n2 = vectorNorm([1, 10], inf)
  62 %%   n2 =
  63 %%       10
  64 %% @end example
  65 %%
  66 %% @seealso{vectors2d, vectorAngle}
  67 %% @end deftypefn
  68
  69 function n = vectorNorm(v, varargin)
  70
  71   % size of vector
  72   dim = size(v);
  73
  74   % extract the type of norm to compute
  75   d = 2;
  76   if ~isempty(varargin)
  77       d = varargin{1};
  78   end
  79
  80   if d==2
  81       % euclidean norm: sum of squared coordinates, and take square root
  82       if dim(1)==1 || dim(2)==1
  83           n = sqrt(sum(v.*v));
  84       else
  85           n = sqrt(sum(v.*v, 2));
  86       end
  87   elseif d==1
  88       % absolute norm: sum of absolute coordinates
  89       if dim(1)==1 || dim(2)==1
  90           n = sum(abs(v));
  91       else
  92           n = sum(abs(v), 2);
  93       end
  94   elseif d==inf
  95       % infinite norm: uses the maximal corodinate
  96       if dim(1)==1 || dim(2)==1
  97           n = max(v);
  98       else
  99           n = max(v, [], 2);
 100       end
 101   else
 102       % Other norms, use explicit but slower expression
 103       if dim(1)==1 || dim(2)==1
 104           n = power(sum(power(v, d)), 1/d);
 105       else
 106           n = power(sum(power(v, d), 2), 1/d);
 107       end
 108   end
 109
 110 endfunction
 111
 112 %!assert (5, vectorNorm ([3 4]))
 113 %!assert(10, vectorNorm ([1, 10], inf))
 114