annotate src/chol.cc @ 2886:969032befa3d

[project @ 1997-04-28 01:17:34 by jwe]
author jwe
date Mon, 28 Apr 1997 01:17:34 +0000
parents 8b262e771614
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
1 /*
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2465
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
4
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
6
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
10 later version.
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
11
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
15 for more details.
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
16
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1192
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
20
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
21 */
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
22
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 180
diff changeset
23 #ifdef HAVE_CONFIG_H
1192
b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe]
jwe
parents: 1009
diff changeset
24 #include <config.h>
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
25 #endif
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
26
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
27 #include "CmplxCHOL.h"
453
393e95f46b51 [project @ 1994-06-06 00:05:20 by jwe]
jwe
parents: 240
diff changeset
28 #include "dbleCHOL.h"
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
29
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
30 #include "defun-dld.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
31 #include "error.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
32 #include "gripes.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
33 #include "help.h"
1740
fe9d3b2ded26 [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents: 1684
diff changeset
34 #include "oct-obj.h"
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
35 #include "utils.h"
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
36
2465
7ee42ff6536a [project @ 1996-11-03 08:54:14 by jwe]
jwe
parents: 2200
diff changeset
37 DEFUN_DLD (chol, args, nargout,
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
38 "R = chol (X): cholesky factorization")
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
39 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
40 octave_value_list retval;
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
41
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
42 int nargin = args.length ();
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
43
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
44 if (nargin != 1 || nargout > 1)
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
45 {
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
46 print_usage ("chol");
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
47 return retval;
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
48 }
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
49
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
50 octave_value arg = args(0);
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
51
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
52 int nr = arg.rows ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
53 int nc = arg.columns ();
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
54
718
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
55 int arg_is_empty = empty_arg ("chol", nr, nc);
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
56
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
57 if (arg_is_empty < 0)
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
58 return retval;
718
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
59 if (arg_is_empty > 0)
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
60 return Matrix ();
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
61
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
62 if (arg.is_real_type ())
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
63 {
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
64 Matrix m = arg.matrix_value ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
65
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
66 if (! error_state)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
67 {
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
68 int info;
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
69 CHOL fact (m, info);
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
70 if (info != 0)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
71 error ("chol: matrix not positive definite");
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
72 else
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
73 retval = fact.chol_matrix ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
74 }
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
75 }
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
76 else if (arg.is_complex_type ())
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
77 {
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
78 ComplexMatrix m = arg.complex_matrix_value ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
79
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
80 if (! error_state)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
81 {
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
82 int info;
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
83 ComplexCHOL fact (m, info);
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
84 if (info != 0)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
85 error ("chol: matrix not positive definite");
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
86 else
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
87 retval = fact.chol_matrix ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
88 }
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
89 }
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
90 else
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
91 {
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
92 gripe_wrong_type_arg ("chol", arg);
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
93 }
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
94
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
95 return retval;
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
96 }
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
97
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
98 /*
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
99 ;;; Local Variables: ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
100 ;;; mode: C++ ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
101 ;;; End: ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
102 */
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
103