annotate scripts/linear-algebra/__norm__.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 4567a35e0777
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6953
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
2 ##
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
4 ##
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6953
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6953
diff changeset
8 ## your option) any later version.
6953
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
9 ##
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
14 ##
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6953
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6953
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6953
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
18
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
19 ## Undocumented internal function.
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
20
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
21 ## Author: jwe
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
22
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
23 function retval = __norm__ (x, p)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
24
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
25 if (nargin < 1 || nargin > 2)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
26 print_usage ();
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
27 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
28
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
29 if (isempty (x))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
30 retval = [];
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
31 return;
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
32 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
33
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
34 if (ndims (x) > 2)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
35 error ("norm: only valid on 2-D objects")
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
36 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
37
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
38 if (nargin == 1)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
39 p = 2;
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
40 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
41
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
42 ## Do we have a vector or matrix as the first argument?
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
43
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
44 if (ndims(x) == 2 && (rows (x) == 1 || columns (x) == 1))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
45 if (ischar (p))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
46 if (strcmp (p, "fro"))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
47 retval = sqrt (sum (abs (x) .^ 2));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
48 elseif (strcmp (p, "inf"))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
49 retval = max (abs (x));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
50 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
51 error ("norm: unrecognized norm");
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
52 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
53 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
54 if (p == Inf)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
55 retval = max (abs (x));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
56 elseif (p == -Inf)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
57 retval = min (abs (x));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
58 elseif (p == 1)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
59 retval = sum (abs (x));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
60 elseif (p == 2)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
61 if (iscomplex (x))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
62 x = abs (x);
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
63 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
64 retval = sqrt (sumsq (x));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
65 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
66 retval = sum (abs (x) .^ p) ^ (1/p);
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
67 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
68 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
69 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
70 if (ischar (p))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
71 if (strcmp (p, "fro"))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
72 retval = sqrt (sum (sum (abs (x) .^ 2)));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
73 elseif (strcmp (p, "inf"))
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
74 retval = max (sum (abs (x')));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
75 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
76 error ("norm: unrecognized vector norm");
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
77 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
78 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
79 if (p == 1)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
80 retval = max (sum (abs (x)));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
81 elseif (p == 2)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
82 s = svd (x);
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
83 retval = s (1);
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
84 elseif (p == Inf)
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
85 retval = max (sum (abs (x')));
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
86 else
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
87 error ("norm: unrecognized matrix norm");
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
88 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
89 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
90 endif
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
91
4567a35e0777 [project @ 2007-10-04 02:53:11 by jwe]
jwe
parents:
diff changeset
92 endfunction