octave: libinterp/corefcn/tril.cc annotate

annotate libinterp/corefcn/tril.cc @ 31605:e88a07dec498 stable

maint: Use macros to begin/end C++ namespaces. * oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE, OCTAVE_END_NAMESPACE) that can be used to start/end a namespace. * mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc, auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h, besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc, defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc, display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc, ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h, event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc, fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc, help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h, interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc, latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h, lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc, ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h, mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc, oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h, oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc, pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc, sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc, variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h, __delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh, mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h, cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h, cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc, op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc, op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h, anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h, comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc, oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h, pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h, pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h, pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h, pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc, pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h, range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc, chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h, oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h, oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc, qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc, randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc, sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc, child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc, file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h, mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h, oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h, file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc, lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h, oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h, oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h, oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h, pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h, url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.

author	Rik <rik@octave.org>
date	Thu, 01 Dec 2022 14:23:45 -0800
parents	796f54d4ddbf
children	597f3ee61a48

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30390 diff changeset	3 // Copyright (C) 2004-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21660 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	28 #endif
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	29
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	30 #include <algorithm>
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	31 #include "Array.h"
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	32 #include "Sparse.h"
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	33 #include "mx-base.h"
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	34
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	35 #include "ov.h"
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	36 #include "Cell.h"
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	37
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	38 #include "defun.h"
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	39 #include "error.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	40 #include "ovl.h"
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	41
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30564 diff changeset	42 OCTAVE_BEGIN_NAMESPACE(octave)
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29931 diff changeset	43
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	44 // The bulk of the work.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21041 diff changeset	45 template <typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	46 static Array<T>
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	47 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	48 {
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	49 octave_idx_type nr = a.rows ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	50 octave_idx_type nc = a.columns ();
29931 7faff48840eb prefer data over fortran_vec for read-only access to data John W. Eaton <jwe@octave.org> parents: 29606 diff changeset	51 const T *avec = a.data ();
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	52 octave_idx_type zero = 0;
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	53
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	54 if (pack)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	55 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	56 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	57 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	58 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	59 Array<T> r (dim_vector (n, 1));
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	60 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	61 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	62 {
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	63 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	64 rvec = std::copy (avec + ii, avec + nr, rvec);
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	65 avec += nr;
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
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	68 return r;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	69 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	70 else
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	71 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	72 Array<T> r (a.dims ());
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	73 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	74 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	75 {
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	76 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	77 std::fill (rvec, rvec + ii, T ());
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	78 std::copy (avec + ii, avec + nr, rvec + ii);
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	79 avec += nr;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	80 rvec += nr;
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
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	83 return r;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	84 }
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
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21041 diff changeset	87 template <typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	88 static Array<T>
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	89 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	90 {
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	91 octave_idx_type nr = a.rows ();
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	92 octave_idx_type nc = a.columns ();
29931 7faff48840eb prefer data over fortran_vec for read-only access to data John W. Eaton <jwe@octave.org> parents: 29606 diff changeset	93 const T *avec = a.data ();
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	94 octave_idx_type zero = 0;
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	95
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	96 if (pack)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	97 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	98 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	99 octave_idx_type j2 = std::min (std::max (zero, nr + k), nc);
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	100 octave_idx_type n
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	101 = ((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	102 Array<T> r (dim_vector (n, 1));
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	103 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	104 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	105 {
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	106 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	107 rvec = std::copy (avec, avec + ii, rvec);
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	108 avec += nr;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	109 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	110
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	111 return r;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	112 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	113 else
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	114 {
27388 90dfdf0d09ad Avoid unnecessary copy on return in triu (bug #56752). Carlo de Falco <carlo.defalco@polimi.it> parents: 26376 diff changeset	115 Array<T> r (a.dims ());
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	116 T *rvec = r.fortran_vec ();
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	117 for (octave_idx_type j = 0; j < nc; j++)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	118 {
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 10155 diff changeset	119 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	120 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	121 std::fill (rvec + ii, rvec + nr, T ());
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	122 avec += nr;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	123 rvec += nr;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	124 }
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 return r;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	127 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	128 }
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 // These two are by David Bateman.
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	131 // FIXME: optimizations possible. "pack" support missing.
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	132
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21041 diff changeset	133 template <typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	134 static Sparse<T>
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	135 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	136 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	137 if (pack) // FIXME
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23583 diff changeset	138 error (R"(tril: "pack" not implemented for sparse matrices)");
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	139
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	140 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	141 octave_idx_type nc = m.cols ();
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	142
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	143 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	144 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	145 if (m.ridx (i) < j-k)
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	146 m.data(i) = 0.;
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 m.maybe_compress (true);
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	149
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	150 return m;
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
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21041 diff changeset	153 template <typename T>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	154 static Sparse<T>
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	155 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	156 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	157 if (pack) // FIXME
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23583 diff changeset	158 error (R"(triu: "pack" not implemented for sparse matrices)");
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	159
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	160 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	161 octave_idx_type nc = m.cols ();
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	162
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	163 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	164 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	165 if (m.ridx (i) > j-k)
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	166 m.data(i) = 0.;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	167
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	168 m.maybe_compress (true);
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	169 return m;
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	170 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	171
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	172 // Convenience dispatchers.
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21041 diff changeset	173 template <typename T>
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	174 static Array<T>
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	175 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	176 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	177 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	178 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	179
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21041 diff changeset	180 template <typename T>
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	181 static Sparse<T>
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	182 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	183 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	184 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	185 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	186
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	187 static octave_value
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	188 do_trilu (const std::string& name,
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	189 const octave_value_list& args)
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	190 {
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	191 bool lower = (name == "tril");
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	192
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	193 int nargin = args.length ();
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	194 bool pack = false;
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	195
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	196 if (nargin >= 2 && args(nargin-1).is_string ())
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	197 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	198 pack = (args(nargin-1).string_value () == "pack");
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	199 nargin--;
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
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	202 if (nargin < 1 \|\| nargin > 2)
d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	203 print_usage ();
d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	204
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	205 octave_idx_type k = 0;
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	206 if (nargin == 2)
21041 63374982750b Usage of corresponding value extractor for octave_idx_type. Improves support Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20974 diff changeset	207 k = args(1).idx_type_value (true);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	208
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	209 octave_value arg = args(0);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	210
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	211 dim_vector dims = arg.dims ();
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21301 diff changeset	212 if (dims.ndims () != 2)
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	213 error ("%s: need a 2-D matrix", name.c_str ());
28110 91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	214 else if (k < -dims(0))
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	215 k = -dims(0);
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	216 else if (k > dims(1))
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	217 k = dims(1);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	218
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	219 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	220
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	221 switch (arg.builtin_type ())
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	222 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	223 case btyp_double:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23577 diff changeset	224 if (arg.issparse ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	225 retval = do_trilu (arg.sparse_matrix_value (), k, lower, pack);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	226 else
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	227 retval = do_trilu (arg.array_value (), k, lower, pack);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	228 break;
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	229
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	230 case btyp_complex:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23577 diff changeset	231 if (arg.issparse ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	232 retval = do_trilu (arg.sparse_complex_matrix_value (), k, lower,
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	233 pack);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	234 else
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	235 retval = do_trilu (arg.complex_array_value (), k, lower, pack);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	236 break;
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	237
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	238 case btyp_bool:
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23577 diff changeset	239 if (arg.issparse ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	240 retval = do_trilu (arg.sparse_bool_matrix_value (), k, lower,
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	241 pack);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	242 else
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	243 retval = do_trilu (arg.bool_array_value (), k, lower, pack);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	244 break;
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	245
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 21966 diff changeset	246 #define ARRAYCASE(TYP) \
e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 21966 diff changeset	247 case btyp_ ## TYP: \
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	248 retval = do_trilu (arg.TYP ## _array_value (), k, lower, pack); \
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	249 break
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	250
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	251 ARRAYCASE (float);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	252 ARRAYCASE (float_complex);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	253 ARRAYCASE (int8);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	254 ARRAYCASE (int16);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	255 ARRAYCASE (int32);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	256 ARRAYCASE (int64);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	257 ARRAYCASE (uint8);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	258 ARRAYCASE (uint16);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	259 ARRAYCASE (uint32);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	260 ARRAYCASE (uint64);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	261 ARRAYCASE (char);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	262
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	263 #undef ARRAYCASE
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	264
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	265 default:
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	266 {
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	267 // Generic code that works on octave-values, that is slow
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	268 // but will also work on arbitrary user types
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	269 if (pack) // FIXME
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23583 diff changeset	270 error (R"(%s: "pack" not implemented for class %s)",
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	271 name.c_str (), arg.class_name ().c_str ());
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	272
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	273 octave_value tmp = arg;
23577 80c42f4cca13 maint: Deprecate is_empty and replace with isempty. Rik <rik@octave.org> parents: 23534 diff changeset	274 if (arg.isempty ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	275 return arg;
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	276
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	277 octave_idx_type nr = dims(0);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	278 octave_idx_type nc = dims(1);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	279
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	280 // The sole purpose of this code is to force the correct matrix size.
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	281 // This would not be necessary if the octave_value resize function
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	282 // allowed a fill_value. It also allows odd attributes in some user
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	283 // types to be handled. With a fill_value, it should be replaced with
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	284 //
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	285 // octave_value_list ov_idx;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	286 // tmp = tmp.resize(dim_vector (0,0)).resize (dims, fill_value);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	287
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	288 octave_value_list ov_idx;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	289 std::list<octave_value_list> idx_tmp;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	290 ov_idx(1) = static_cast<double> (nc+1);
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	291 ov_idx(0) = range<double> (1, nr);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	292 idx_tmp.push_back (ov_idx);
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	293 ov_idx(1) = static_cast<double> (nc);
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 29961 diff changeset	294 tmp = tmp.resize (dim_vector (0, 0));
28631 70cdf8de553d move non-member octave_value operator functions to octave namespace John W. Eaton <jwe@octave.org> parents: 28110 diff changeset	295 tmp = tmp.subsasgn ("(", idx_tmp, arg.index_op (ov_idx));
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	296 tmp = tmp.resize (dims);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	297
29606 270ffe1e7647 tril.cc: Use standard functions for min and max operations. Markus Mützel <markus.muetzel@gmx.de> parents: 29359 diff changeset	298 octave_idx_type one = 1;
270ffe1e7647 tril.cc: Use standard functions for min and max operations. Markus Mützel <markus.muetzel@gmx.de> parents: 29359 diff changeset	299
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	300 if (lower)
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	301 {
29606 270ffe1e7647 tril.cc: Use standard functions for min and max operations. Markus Mützel <markus.muetzel@gmx.de> parents: 29359 diff changeset	302 octave_idx_type st = std::min (nc, nr + k);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	303
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	304 for (octave_idx_type j = 1; j <= st; j++)
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	305 {
29606 270ffe1e7647 tril.cc: Use standard functions for min and max operations. Markus Mützel <markus.muetzel@gmx.de> parents: 29359 diff changeset	306 octave_idx_type nr_limit = std::max (one, j - k);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	307 ov_idx(1) = static_cast<double> (j);
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	308 ov_idx(0) = range<double> (nr_limit, nr);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	309 std::list<octave_value_list> idx;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	310 idx.push_back (ov_idx);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	311
28631 70cdf8de553d move non-member octave_value operator functions to octave namespace John W. Eaton <jwe@octave.org> parents: 28110 diff changeset	312 tmp = tmp.subsasgn ("(", idx, arg.index_op (ov_idx));
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	313 }
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	314 }
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	315 else
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	316 {
29606 270ffe1e7647 tril.cc: Use standard functions for min and max operations. Markus Mützel <markus.muetzel@gmx.de> parents: 29359 diff changeset	317 octave_idx_type st = std::max (k + 1, one);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	318
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	319 for (octave_idx_type j = st; j <= nc; j++)
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	320 {
29606 270ffe1e7647 tril.cc: Use standard functions for min and max operations. Markus Mützel <markus.muetzel@gmx.de> parents: 29359 diff changeset	321 octave_idx_type nr_limit = std::min (nr, j - k);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	322 ov_idx(1) = static_cast<double> (j);
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	323 ov_idx(0) = range<double> (1, nr_limit);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	324 std::list<octave_value_list> idx;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	325 idx.push_back (ov_idx);
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	326
28631 70cdf8de553d move non-member octave_value operator functions to octave namespace John W. Eaton <jwe@octave.org> parents: 28110 diff changeset	327 tmp = tmp.subsasgn ("(", idx, arg.index_op (ov_idx));
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	328 }
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	329 }
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	330
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	331 retval = tmp;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	332 }
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	333 }
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 return retval;
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
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	338 DEFUN (tril, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	339 doc: /* -- texinfo --
25018 ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	340 @deftypefn {} {@var{A_LO} =} tril (@var{A})
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	341 @deftypefnx {} {@var{A_LO} =} tril (@var{A}, @var{k})
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	342 @deftypefnx {} {@var{A_LO} =} tril (@var{A}, @var{k}, @var{pack})
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	343 Return a new matrix formed by extracting the lower triangular part of the
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	344 matrix @var{A}, and setting all other elements to zero.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	345
25018 ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	346 The optional second argument specifies how many diagonals above or below the
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	347 main diagonal should also be set to zero. The default value of @var{k} is
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	348 zero which includes the main diagonal as part of the result. If the value of
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	349 @var{k} is a nonzero integer then the selection of elements starts at an offset
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	350 of @var{k} diagonals above the main diagonal for positive @var{k} or below the
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	351 main diagonal for negative @var{k}. The absolute value of @var{k} may not be
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	352 greater than the number of subdiagonals or superdiagonals.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	353
25018 ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	354 Example 1 : exclude main diagonal
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	355
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	356 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	357 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	358 tril (ones (3), -1)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	359 @result{} 0 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	360 1 0 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	361 1 1 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	362 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	363 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	364
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	365 @noindent
25018 ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	366
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	367 Example 2 : include first superdiagonal
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	368
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	369 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	370 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	371 tril (ones (3), 1)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	372 @result{} 1 1 0
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	373 1 1 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	374 1 1 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	375 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	376 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	377
25018 ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	378 If the optional third argument @qcode{"pack"} is given then the extracted
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	379 elements are not inserted into a matrix, but instead stacked column-wise one
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	380 above another, and returned as a column vector.
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	381 @seealso{triu, istril, diag}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	382 @end deftypefn */)
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	383 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	384 return do_trilu ("tril", args);
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	385 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	386
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	387 DEFUN (triu, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	388 doc: /* -- texinfo --
25018 ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	389 @deftypefn {} {@var{A_UP} =} triu (@var{A})
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	390 @deftypefnx {} {@var{A_UP} =} triu (@var{A}, @var{k})
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	391 @deftypefnx {} {@var{A_UP} =} triu (@var{A}, @var{k}, @var{pack})
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	392 Return a new matrix formed by extracting the upper triangular part of the
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	393 matrix @var{A}, and setting all other elements to zero.
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	394
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	395 The optional second argument specifies how many diagonals above or below the
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	396 main diagonal should also be set to zero. The default value of @var{k} is
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	397 zero which includes the main diagonal as part of the result. If the value of
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	398 @var{k} is a nonzero integer then the selection of elements starts at an offset
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	399 of @var{k} diagonals above the main diagonal for positive @var{k} or below the
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	400 main diagonal for negative @var{k}. The absolute value of @var{k} may not be
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	401 greater than the number of subdiagonals or superdiagonals.
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	402
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	403 Example 1 : exclude main diagonal
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	404
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	405 @example
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	406 @group
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	407 triu (ones (3), 1)
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	408 @result{} 0 1 1
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	409 0 0 1
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	410 0 0 0
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	411 @end group
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	412 @end example
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	413
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	414 @noindent
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	415
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	416 Example 2 : include first subdiagonal
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	417
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	418 @example
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	419 @group
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	420 triu (ones (3), -1)
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	421 @result{} 1 1 1
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	422 1 1 1
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	423 0 1 1
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	424 @end group
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	425 @end example
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	426
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	427 If the optional third argument @qcode{"pack"} is given then the extracted
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	428 elements are not inserted into a matrix, but instead stacked column-wise one
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	429 above another, and returned as a column vector.
ed3d7a33551b doc: Redo documentation for tril and triu. Rik <rik@octave.org> parents: 24534 diff changeset	430 @seealso{tril, istriu, diag}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	431 @end deftypefn */)
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	432 {
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	433 return do_trilu ("triu", args);
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	434 }
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	435
b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	436 /*
28110 91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	437 %!shared a, l2, l1, l0, lm1, lm2, lm3, lm4
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	438 %! 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	439 %!
28110 91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	440 %! l2 = [1, 2, 3; 4, 5, 6; 7, 8, 9; 10, 11, 12];
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	441 %! l1 = [1, 2, 0; 4, 5, 6; 7, 8, 9; 10, 11, 12];
28110 91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	442 %! l0 = [1, 0, 0; 4, 5, 0; 7, 8, 9; 10, 11, 12];
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	443 %! 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	444 %! 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	445 %! 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	446 %! 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	447 %!
28907 11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	448 %!assert (tril (a, 3), l2)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	449 %!assert (tril (a, 2), l2)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	450 %!assert (tril (a, 1), l1)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	451 %!assert (tril (a, 0), l0)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	452 %!assert (tril (a), l0)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	453 %!assert (tril (a, -1), lm1)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	454 %!assert (tril (a, -2), lm2)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	455 %!assert (tril (a, -3), lm3)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	456 %!assert (tril (a, -4), lm4)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	457 %!assert (tril (a, -5), lm4)
28110 91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	458
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	459 %!shared a, u3, u2, u1, u0, um1, um2, um3
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	460 %!
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	461 %! a = [1, 2, 3; 4, 5, 6; 7, 8, 9; 10, 11, 12];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	462 %!
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	463 %! u3 = [0, 0, 0; 0, 0, 0; 0, 0, 0; 0, 0, 0];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	464 %! u2 = [0, 0, 3; 0, 0, 0; 0, 0, 0; 0, 0, 0];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	465 %! u1 = [0, 2, 3; 0, 0, 6; 0, 0, 0; 0, 0, 0];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	466 %! u0 = [1, 2, 3; 0, 5, 6; 0, 0, 9; 0, 0, 0];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	467 %! um1 = [1, 2, 3; 4, 5, 6; 0, 8, 9; 0, 0, 12];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	468 %! um2 = [1, 2, 3; 4, 5, 6; 7, 8, 9; 0, 11, 12];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	469 %! um3 = [1, 2, 3; 4, 5, 6; 7, 8, 9; 10, 11, 12];
91f245908132 allow K to be out of range in tril and triu functions John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	470 %!
28907 11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	471 %!assert (triu (a, 4), u3)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	472 %!assert (triu (a, 3), u3)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	473 %!assert (triu (a, 2), u2)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	474 %!assert (triu (a, 1), u1)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	475 %!assert (triu (a, 0), u0)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	476 %!assert (triu (a), u0)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	477 %!assert (triu (a, -1), um1)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	478 %!assert (triu (a, -2), um2)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	479 %!assert (triu (a, -3), um3)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28888 diff changeset	480 %!assert (triu (a, -4), um3)
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	481
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	482 %!error tril ()
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	483 %!error triu ()
9756 b134960cea23 implement built-in tril/triu Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	484 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29931 diff changeset	485
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30564 diff changeset	486 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

annotate libinterp/corefcn/tril.cc @ 31605:e88a07dec498 stable