annotate src/chol.cc @ 1315:611d403c7f3d

[project @ 1995-06-25 19:56:32 by jwe]
author jwe
date Sun, 25 Jun 1995 19:56:32 +0000
parents b6360f2d4fa6
children 19c10b8657d5
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 // f-chol.cc -*- C++ -*-
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
2 /*
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
3
1009
dfe01093f657 [project @ 1995-01-04 04:05:12 by jwe]
jwe
parents: 718
diff changeset
4 Copyright (C) 1993, 1994, 1995 John W. Eaton
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
5
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
7
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
8 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
9 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
10 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
11 later version.
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
12
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
13 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
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
15 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
16 for more details.
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
17
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
18 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
19 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
20 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
21
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
22 */
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
23
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 180
diff changeset
24 #ifdef HAVE_CONFIG_H
1192
b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe]
jwe
parents: 1009
diff changeset
25 #include <config.h>
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
26 #endif
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
27
453
393e95f46b51 [project @ 1994-06-06 00:05:20 by jwe]
jwe
parents: 240
diff changeset
28 #include "dbleCHOL.h"
393e95f46b51 [project @ 1994-06-06 00:05:20 by jwe]
jwe
parents: 240
diff changeset
29 #include "CmplxCHOL.h"
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
30
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
31 #include "tree-const.h"
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
32 #include "user-prefs.h"
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
33 #include "gripes.h"
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
34 #include "error.h"
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
35 #include "utils.h"
544
20fbad23ae51 [project @ 1994-07-22 05:04:44 by jwe]
jwe
parents: 519
diff changeset
36 #include "help.h"
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
37 #include "defun-dld.h"
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
38
701
0a81458ef677 [project @ 1994-09-15 02:23:24 by jwe]
jwe
parents: 636
diff changeset
39 DEFUN_DLD_BUILTIN ("chol", Fchol, Schol, 2, 1,
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
40 "R = chol (X): cholesky factorization")
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
41 {
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
42 Octave_object retval;
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
43
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
44 int nargin = args.length ();
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
45
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
46 if (nargin != 1 || nargout > 1)
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
47 {
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
48 print_usage ("chol");
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
49 return retval;
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
50 }
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
51
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
52 tree_constant arg = args(0);
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
53
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
54 int nr = arg.rows ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
55 int nc = arg.columns ();
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
56
718
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
57 int arg_is_empty = empty_arg ("chol", nr, nc);
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
58
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
59 if (arg_is_empty < 0)
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
60 return retval;
718
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
61 if (arg_is_empty > 0)
e81d3a66725e [project @ 1994-09-21 14:58:18 by jwe]
jwe
parents: 712
diff changeset
62 return Matrix ();
519
b9284136189a [project @ 1994-07-19 14:40:20 by jwe]
jwe
parents: 516
diff changeset
63
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
64 if (arg.is_real_type ())
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
65 {
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
66 Matrix m = arg.matrix_value ();
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 if (! error_state)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
69 {
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
70 int info;
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
71 CHOL fact (m, info);
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
72 if (info != 0)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
73 error ("chol: matrix not positive definite");
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
74 else
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
75 retval = fact.chol_matrix ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
76 }
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
77 }
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
78 else if (arg.is_complex_type ())
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
79 {
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
80 ComplexMatrix m = arg.complex_matrix_value ();
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 if (! error_state)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
83 {
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
84 int info;
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
85 ComplexCHOL fact (m, info);
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
86 if (info != 0)
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
87 error ("chol: matrix not positive definite");
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
88 else
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
89 retval = fact.chol_matrix ();
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
90 }
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
91 }
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
92 else
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
93 {
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 620
diff changeset
94 gripe_wrong_type_arg ("chol", arg);
620
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
95 }
8e4e7e5f307e [project @ 1994-08-16 04:36:32 by jwe]
jwe
parents: 544
diff changeset
96
180
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
97 return retval;
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
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
100 /*
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
101 ;;; Local Variables: ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
102 ;;; mode: C++ ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
103 ;;; page-delimiter: "^/\\*" ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
104 ;;; End: ***
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
105 */
de63a156b36e [project @ 1993-10-23 22:45:17 by jwe]
jwe
parents:
diff changeset
106