Mercurial > hg > octave-nkf

annotate libinterp/corefcn/tril.cc @ 15624:550147454137

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: periodic merge of stable to default
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Fri, 23 Nov 2012 11:43:49 -0500
parents src/DLD-FUNCTIONS/tril.cc@7f4e7073b2e0 src/DLD-FUNCTIONS/tril.cc@2fc554ffbc28
children 12005245b645
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
1 /*
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
2
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12639
diff changeset
3 Copyright (C) 2004-2012 David Bateman
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
4 Copyright (C) 2009 VZLU Prague
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
5
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
6 This file is part of Octave.
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
7
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
9 under the terms of the GNU General Public License as published by the
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
11 option) any later version.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
12
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
16 for more details.
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
17
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
19 along with Octave; see the file COPYING. If not, see
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
20 <http://www.gnu.org/licenses/>.
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
21
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
22 */
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
23
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
24 #ifdef HAVE_CONFIG_H
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
25 #include <config.h>
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 #endif
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28 #include <algorithm>
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
29 #include "Array.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
30 #include "Sparse.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
31 #include "mx-base.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 #include "ov.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 #include "Cell.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
36 #include "defun.h"
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
37 #include "error.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
38 #include "oct-obj.h"
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
39
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
40 // The bulk of the work.
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 template <class T>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
42 static Array<T>
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43 do_tril (const Array<T>& a, octave_idx_type k, bool pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
44 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
45 octave_idx_type nr = a.rows (), nc = a.columns ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
46 const T *avec = a.fortran_vec ();
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
47 octave_idx_type zero = 0;
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
48
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
49 if (pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
50 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
51 octave_idx_type j1 = std::min (std::max (zero, k), nc);
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
52 octave_idx_type j2 = std::min (std::max (zero, nr + k), nc);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
53 octave_idx_type n = j1 * nr + ((j2 - j1) * (nr-(j1-k) + nr-(j2-1-k))) / 2;
11570
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
54 Array<T> r (dim_vector (n, 1));
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
56 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
57 {
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
58 octave_idx_type ii = std::min (std::max (zero, j - k), nr);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
59 rvec = std::copy (avec + ii, avec + nr, rvec);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
60 avec += nr;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
61 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
62
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
63 return r;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
64 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
65 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
66 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
67 Array<T> r (a.dims ());
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
68 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
69 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
70 {
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
71 octave_idx_type ii = std::min (std::max (zero, j - k), nr);
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14501
diff changeset
72 std::fill (rvec, rvec + ii, T ());
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
73 std::copy (avec + ii, avec + nr, rvec + ii);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
74 avec += nr;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
75 rvec += nr;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
76 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
77
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
78 return r;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
79 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
80 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
81
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
82 template <class T>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
83 static Array<T>
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
84 do_triu (const Array<T>& a, octave_idx_type k, bool pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
85 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
86 octave_idx_type nr = a.rows (), nc = a.columns ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
87 const T *avec = a.fortran_vec ();
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
88 octave_idx_type zero = 0;
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
89
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
90 if (pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
91 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
92 octave_idx_type j1 = std::min (std::max (zero, k), nc);
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
93 octave_idx_type j2 = std::min (std::max (zero, nr + k), nc);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
94 octave_idx_type n = ((j2 - j1) * ((j1+1-k) + (j2-k))) / 2 + (nc - j2) * nr;
11570
57632dea2446 attempt better backward compatibility for Array constructors
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
95 Array<T> r (dim_vector (n, 1));
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
96 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
97 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
98 {
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
99 octave_idx_type ii = std::min (std::max (zero, j + 1 - k), nr);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
100 rvec = std::copy (avec, avec + ii, rvec);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
101 avec += nr;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
102 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
103
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
104 return r;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
105 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
106 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
107 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
108 NoAlias<Array<T> > r (a.dims ());
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
109 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
110 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
111 {
10258
e317791645c4 64-bit fixes
John W. Eaton <jwe@octave.org>
parents: 10155
diff changeset
112 octave_idx_type ii = std::min (std::max (zero, j + 1 - k), nr);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
113 std::copy (avec, avec + ii, rvec);
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14501
diff changeset
114 std::fill (rvec + ii, rvec + nr, T ());
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
115 avec += nr;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
116 rvec += nr;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
117 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
118
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
119 return r;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
120 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
121 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
122
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
123 // These two are by David Bateman.
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
124 // FIXME: optimizations possible. "pack" support missing.
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
125
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
126 template <class T>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
127 static Sparse<T>
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
128 do_tril (const Sparse<T>& a, octave_idx_type k, bool pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
129 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
130 if (pack) // FIXME
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
131 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
132 error ("tril: \"pack\" not implemented for sparse matrices");
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
133 return Sparse<T> ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
134 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
135
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
136 Sparse<T> m = a;
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14501
diff changeset
137 octave_idx_type nc = m.cols ();
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
138
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
139 for (octave_idx_type j = 0; j < nc; j++)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
140 for (octave_idx_type i = m.cidx (j); i < m.cidx (j+1); i++)
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
141 if (m.ridx (i) < j-k)
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
142 m.data(i) = 0.;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
143
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
144 m.maybe_compress (true);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
145 return m;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
146 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
147
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
148 template <class T>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
149 static Sparse<T>
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
150 do_triu (const Sparse<T>& a, octave_idx_type k, bool pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
151 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
152 if (pack) // FIXME
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
153 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
154 error ("triu: \"pack\" not implemented for sparse matrices");
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
155 return Sparse<T> ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
156 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
157
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
158 Sparse<T> m = a;
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14501
diff changeset
159 octave_idx_type nc = m.cols ();
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
160
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
161 for (octave_idx_type j = 0; j < nc; j++)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
162 for (octave_idx_type i = m.cidx (j); i < m.cidx (j+1); i++)
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
163 if (m.ridx (i) > j-k)
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
164 m.data(i) = 0.;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
165
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
166 m.maybe_compress (true);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
167 return m;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
168 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
169
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
170 // Convenience dispatchers.
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
171 template <class T>
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
172 static Array<T>
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
173 do_trilu (const Array<T>& a, octave_idx_type k, bool lower, bool pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
174 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
175 return lower ? do_tril (a, k, pack) : do_triu (a, k, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
176 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
177
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
178 template <class T>
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
179 static Sparse<T>
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
180 do_trilu (const Sparse<T>& a, octave_idx_type k, bool lower, bool pack)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
181 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
182 return lower ? do_tril (a, k, pack) : do_triu (a, k, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
183 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
184
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
185 static octave_value
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
186 do_trilu (const std::string& name,
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
187 const octave_value_list& args)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
188 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
189 bool lower = name == "tril";
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
190
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
191 octave_value retval;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
192 int nargin = args.length ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
193 octave_idx_type k = 0;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
194 bool pack = false;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
195 if (nargin >= 2 && args(nargin-1).is_string ())
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
196 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
197 pack = args(nargin-1).string_value () == "pack";
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
198 nargin--;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
199 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
200
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
201 if (nargin == 2)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
202 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
203 k = args(1).int_value (true);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
204
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
205 if (error_state)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9756
diff changeset
206 return retval;
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
207 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
208
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
209 if (nargin < 1 || nargin > 2)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
210 print_usage ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
211 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
212 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
213 octave_value arg = args (0);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
214
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
215 dim_vector dims = arg.dims ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
216 if (dims.length () != 2)
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
217 error ("%s: need a 2-D matrix", name.c_str ());
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
218 else if (k < -dims (0) || k > dims(1))
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
219 error ("%s: requested diagonal out of range", name.c_str ());
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
220 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
221 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
222 switch (arg.builtin_type ())
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
223 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
224 case btyp_double:
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
225 if (arg.is_sparse_type ())
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
226 retval = do_trilu (arg.sparse_matrix_value (), k, lower, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
227 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
228 retval = do_trilu (arg.array_value (), k, lower, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
229 break;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
230 case btyp_complex:
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
231 if (arg.is_sparse_type ())
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
232 retval = do_trilu (arg.sparse_complex_matrix_value (), k, lower, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
233 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
234 retval = do_trilu (arg.complex_array_value (), k, lower, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
235 break;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
236 case btyp_bool:
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
237 if (arg.is_sparse_type ())
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
238 retval = do_trilu (arg.sparse_bool_matrix_value (), k, lower, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
239 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
240 retval = do_trilu (arg.bool_array_value (), k, lower, pack);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
241 break;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
242 #define ARRAYCASE(TYP) \
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
243 case btyp_ ## TYP: \
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
244 retval = do_trilu (arg.TYP ## _array_value (), k, lower, pack); \
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
245 break
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
246 ARRAYCASE (float);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
247 ARRAYCASE (float_complex);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
248 ARRAYCASE (int8);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
249 ARRAYCASE (int16);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
250 ARRAYCASE (int32);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
251 ARRAYCASE (int64);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
252 ARRAYCASE (uint8);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
253 ARRAYCASE (uint16);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
254 ARRAYCASE (uint32);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
255 ARRAYCASE (uint64);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
256 ARRAYCASE (char);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
257 #undef ARRAYCASE
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
258 default:
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
259 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
260 // Generic code that works on octave-values, that is slow
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
261 // but will also work on arbitrary user types
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
262
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
263 if (pack) // FIXME
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
264 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
265 error ("%s: \"pack\" not implemented for class %s",
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
266 name.c_str (), arg.class_name ().c_str ());
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
267 return octave_value ();
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
268 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
269
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
270 octave_value tmp = arg;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
271 if (arg.numel () == 0)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
272 return arg;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
273
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
274 octave_idx_type nr = dims(0), nc = dims (1);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
275
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
276 // The sole purpose of the below is to force the correct
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
277 // matrix size. This would not be necessary if the
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
278 // octave_value resize function allowed a fill_value.
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
279 // It also allows odd attributes in some user types
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
280 // to be handled. With a fill_value ot should be replaced
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
281 // with
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
282 //
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
283 // octave_value_list ov_idx;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
284 // tmp = tmp.resize(dim_vector (0,0)).resize (dims, fill_value);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
285
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
286 octave_value_list ov_idx;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
287 std::list<octave_value_list> idx_tmp;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
288 ov_idx(1) = static_cast<double> (nc+1);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
289 ov_idx(0) = Range (1, nr);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
290 idx_tmp.push_back (ov_idx);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
291 ov_idx(1) = static_cast<double> (nc);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
292 tmp = tmp.resize (dim_vector (0,0));
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
293 tmp = tmp.subsasgn ("(",idx_tmp, arg.do_index_op (ov_idx));
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
294 tmp = tmp.resize (dims);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
295
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
296 if (lower)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
297 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
298 octave_idx_type st = nc < nr + k ? nc : nr + k;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
299
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
300 for (octave_idx_type j = 1; j <= st; j++)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
301 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
302 octave_idx_type nr_limit = 1 > j - k ? 1 : j - k;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
303 ov_idx(1) = static_cast<double> (j);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
304 ov_idx(0) = Range (nr_limit, nr);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
305 std::list<octave_value_list> idx;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
306 idx.push_back (ov_idx);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
307
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
308 tmp = tmp.subsasgn ("(", idx, arg.do_index_op (ov_idx));
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
309
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
310 if (error_state)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
311 return retval;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
312 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
313 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
314 else
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
315 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
316 octave_idx_type st = k + 1 > 1 ? k + 1 : 1;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
317
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
318 for (octave_idx_type j = st; j <= nc; j++)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
319 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
320 octave_idx_type nr_limit = nr < j - k ? nr : j - k;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
321 ov_idx(1) = static_cast<double> (j);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
322 ov_idx(0) = Range (1, nr_limit);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
323 std::list<octave_value_list> idx;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
324 idx.push_back (ov_idx);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
325
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
326 tmp = tmp.subsasgn ("(", idx, arg.do_index_op (ov_idx));
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
327
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
328 if (error_state)
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
329 return retval;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
330 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
331 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
332
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
333 retval = tmp;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
334 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
335 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
336 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
337 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
338
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
339 return retval;
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
340 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
341
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
342 DEFUN (tril, args, ,
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
343 "-*- texinfo -*-\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
344 @deftypefn {Function File} {} tril (@var{A})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
345 @deftypefnx {Function File} {} tril (@var{A}, @var{k})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
346 @deftypefnx {Function File} {} tril (@var{A}, @var{k}, @var{pack})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
347 @deftypefnx {Function File} {} triu (@var{A})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
348 @deftypefnx {Function File} {} triu (@var{A}, @var{k})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
349 @deftypefnx {Function File} {} triu (@var{A}, @var{k}, @var{pack})\n\
11152
39ae406df598 Improve docstrings for functions found in undocumented list.
Rik <octave@nomad.inbox5.com>
parents: 11104
diff changeset
350 Return a new matrix formed by extracting the lower (@code{tril})\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
351 or upper (@code{triu}) triangular part of the matrix @var{A}, and\n\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
352 setting all other elements to zero. The second argument is optional,\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
353 and specifies how many diagonals above or below the main diagonal should\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
354 also be set to zero.\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
355 \n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
356 The default value of @var{k} is zero, so that @code{triu} and\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
357 @code{tril} normally include the main diagonal as part of the result.\n\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
358 \n\
15622
7f4e7073b2e0 doc: fix description of k in triu/tril (bug #37796)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
359 If the value of @var{k} is nonzero integer, the selection of elements\
7f4e7073b2e0 doc: fix description of k in triu/tril (bug #37796)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
360 starts at an offset of @var{k} diagonals above or below the main\
7f4e7073b2e0 doc: fix description of k in triu/tril (bug #37796)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
361 diagonal; above for positive @var{k} and below for negative @var{k}.\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
362 \n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
363 The absolute value of @var{k} must not be greater than the number of\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
364 sub-diagonals or super-diagonals.\n\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
365 \n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
366 For example:\n\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
367 \n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
368 @example\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
369 @group\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
370 tril (ones (3), -1)\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
371 @result{} 0 0 0\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
372 1 0 0\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
373 1 1 0\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
374 @end group\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
375 @end example\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
376 \n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
377 @noindent\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
378 and\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
379 \n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
380 @example\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
381 @group\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
382 tril (ones (3), 1)\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
383 @result{} 1 1 0\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
384 1 1 1\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
385 1 1 1\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
386 @end group\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
387 @end example\n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
388 \n\
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
389 If the option \"pack\" is given as third argument, the extracted elements\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
390 are not inserted into a matrix, but rather stacked column-wise one above\n\
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
391 other.\n\
12639
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
392 @seealso{diag}\n\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
393 @end deftypefn")
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
394 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
395 return do_trilu ("tril", args);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
396 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
397
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
398 DEFUN (triu, args, ,
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
399 "-*- texinfo -*-\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
400 @deftypefn {Function File} {} triu (@var{A})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
401 @deftypefnx {Function File} {} triu (@var{A}, @var{k})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
402 @deftypefnx {Function File} {} triu (@var{A}, @var{k}, @var{pack})\n\
12546
39ca02387a32 Improve docstrings for a number of functions.
Rik <octave@nomad.inbox5.com>
parents: 11586
diff changeset
403 See the documentation for the @code{tril} function (@pxref{tril}).\n\
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
404 @end deftypefn")
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
405 {
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
406 return do_trilu ("triu", args);
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
407 }
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
408
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
409 /*
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
410 %!test
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
411 %! a = [1, 2, 3; 4, 5, 6; 7, 8, 9; 10, 11, 12];
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
412 %!
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
413 %! l0 = [1, 0, 0; 4, 5, 0; 7, 8, 9; 10, 11, 12];
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
414 %! l1 = [1, 2, 0; 4, 5, 6; 7, 8, 9; 10, 11, 12];
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
415 %! l2 = [1, 2, 3; 4, 5, 6; 7, 8, 9; 10, 11, 12];
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
416 %! lm1 = [0, 0, 0; 4, 0, 0; 7, 8, 0; 10, 11, 12];
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
417 %! lm2 = [0, 0, 0; 0, 0, 0; 7, 0, 0; 10, 11, 0];
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
418 %! lm3 = [0, 0, 0; 0, 0, 0; 0, 0, 0; 10, 0, 0];
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
419 %! lm4 = [0, 0, 0; 0, 0, 0; 0, 0, 0; 0, 0, 0];
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11570
diff changeset
420 %!
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
421 %! assert (tril (a, -4), lm4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
422 %! assert (tril (a, -3), lm3);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
423 %! assert (tril (a, -2), lm2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
424 %! assert (tril (a, -1), lm1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
425 %! assert (tril (a), l0);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
426 %! assert (tril (a, 1), l1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
427 %! assert (tril (a, 2), l2);
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
428
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
429 %!error tril ()
9756
b134960cea23 implement built-in tril/triu
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
430 */