octave: libinterp/corefcn/dot.cc annotate

annotate libinterp/corefcn/dot.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	32d2b6604a9f
children	dfa5d9c3ae72 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: 29997 diff changeset	3 // Copyright (C) 2009-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 ////////////////////////////////////////////////////////////////////////
9874 90bc0cc4518f implement compiled dot and blkmm 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"
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	28 #endif
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	29
22322 93b3cdd36854 move most f77 function decls to separate header files John W. Eaton <jwe@octave.org> parents: 22135 diff changeset	30 #include "lo-blas-proto.h"
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	31 #include "mx-base.h"
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	32
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	33 #include "builtin-defun-decls.h"
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	34 #include "defun.h"
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	35 #include "error.h"
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	36 #include "parse.h"
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	37
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30888 diff changeset	38 OCTAVE_BEGIN_NAMESPACE(octave)
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	39
30723 08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30564 diff changeset	40 // FIXME: input 'y' is no longer necessary (2/5/2022).
08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30564 diff changeset	41 // At some point it would be better to change all occurrences of
08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30564 diff changeset	42 // get_red_dims to eliminate this input parameter.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	43 static void
30723 08b08b7f05b2 Replace direct calls to C library assert() with Octave specialty functions in libinterp/ (bug #61753) Arun Giridhar <arungiridhar@gmail.com> and Rik <rik@octave.org> parents: 30564 diff changeset	44 get_red_dims (const dim_vector& x, const dim_vector& /* y */, int dim,
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	45 dim_vector& z, F77_INT& m, F77_INT& n, F77_INT& k)
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	46 {
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21301 diff changeset	47 int nd = x.ndims ();
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	48 z = dim_vector::alloc (nd);
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	49 octave_idx_type tmp_m = 1;
b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	50 octave_idx_type tmp_n = 1;
b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	51 octave_idx_type tmp_k = 1;
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	52 for (int i = 0; i < nd; i++)
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	53 {
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	54 if (i < dim)
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	55 {
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	56 z(i) = x(i);
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	57 tmp_m *= x(i);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	58 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	59 else if (i > dim)
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	60 {
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	61 z(i) = x(i);
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	62 tmp_n *= x(i);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	63 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	64 else
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	65 {
26493 bc6237a189e1 dot.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	66 z(i) = 1;
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	67 tmp_k = x(i);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	68 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	69 }
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	70
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	71 m = to_f77_int (tmp_m);
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	72 n = to_f77_int (tmp_n);
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	73 k = to_f77_int (tmp_k);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	74 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	75
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	76 DEFUN (dot, 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	77 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30723 diff changeset	78 @deftypefn {} {@var{z} =} dot (@var{x}, @var{y})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30723 diff changeset	79 @deftypefnx {} {@var{z} =} dot (@var{x}, @var{y}, @var{dim})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	80 Compute the dot product of two vectors.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	81
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	82 If @var{x} and @var{y} are matrices, calculate the dot products along the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	83 first non-singleton dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	84
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	85 If the optional argument @var{dim} is given, calculate the dot products
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	86 along this dimension.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	87
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	88 Implementation Note: This is equivalent to
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	89 @code{sum (conj (@var{X}) .* @var{Y}, @var{dim})}, but avoids forming a
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	90 temporary array and is faster. When @var{X} and @var{Y} are column vectors,
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	91 the result is equivalent to @code{@var{X}' * @var{Y}}. Although, @code{dot}
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	92 is defined for integer arrays, the output may differ from the expected result
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	93 due to the limited range of integer objects.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	94 @seealso{cross, divergence}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	95 @end deftypefn */)
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	96 {
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	97 int nargin = args.length ();
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	98
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	99 if (nargin < 2 \|\| nargin > 3)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20556 diff changeset	100 print_usage ();
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	101
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	102 octave_value retval;
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	103 octave_value argx = args(0);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	104 octave_value argy = args(1);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	105
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	106 if (! argx.isnumeric () \|\| ! argy.isnumeric ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	107 error ("dot: X and Y must be numeric");
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	108
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	109 dim_vector dimx = argx.dims ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	110 dim_vector dimy = argy.dims ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	111 bool match = dimx == dimy;
23592 80e3bfb7bd5a maint: Deprecate is_vector and replace with isvector. Rik <rik@octave.org> parents: 23586 diff changeset	112 if (! match && nargin == 2 && dimx.isvector () && dimy.isvector ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	113 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	114 // Change to column vectors.
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	115 dimx = dimx.redim (1);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	116 argx = argx.reshape (dimx);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	117 dimy = dimy.redim (1);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	118 argy = argy.reshape (dimy);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	119 match = dimx == dimy;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	120 }
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	121
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	122 if (! match)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	123 error ("dot: sizes of X and Y must match");
20556 4bed806ee3d4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	124
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	125 int dim;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	126 if (nargin == 2)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	127 dim = dimx.first_non_singleton ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	128 else
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	129 dim = args(2).int_value (true) - 1;
20556 4bed806ee3d4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	130
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	131 if (dim < 0)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	132 error ("dot: DIM must be a valid dimension");
20556 4bed806ee3d4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	133
22980 b4346e1b5b45 use F77_INT instead of octave_idx_type for libinterp dot function John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	134 F77_INT m, n, k;
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	135 dim_vector dimz;
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23220 diff changeset	136 if (argx.iscomplex () \|\| argy.iscomplex ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	137 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	138 if (argx.is_single_type () \|\| argy.is_single_type ())
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	139 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	140 FloatComplexNDArray x = argx.float_complex_array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	141 FloatComplexNDArray y = argy.float_complex_array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	142 get_red_dims (dimx, dimy, dim, dimz, m, n, k);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	143 FloatComplexNDArray z (dimz);
20556 4bed806ee3d4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	144
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	145 F77_XFCN (cdotc3, CDOTC3, (m, n, k,
22135 407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531) John W. Eaton <jwe@octave.org> parents: 22133 diff changeset	146 F77_CONST_CMPLX_ARG (x.data ()), F77_CONST_CMPLX_ARG (y.data ()),
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531) John W. Eaton <jwe@octave.org> parents: 22133 diff changeset	147 F77_CMPLX_ARG (z.fortran_vec ())));
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	148 retval = z;
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	149 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	150 else
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	151 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	152 ComplexNDArray x = argx.complex_array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	153 ComplexNDArray y = argy.complex_array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	154 get_red_dims (dimx, dimy, dim, dimz, m, n, k);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	155 ComplexNDArray z (dimz);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	156
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	157 F77_XFCN (zdotc3, ZDOTC3, (m, n, k,
22135 407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531) John W. Eaton <jwe@octave.org> parents: 22133 diff changeset	158 F77_CONST_DBLE_CMPLX_ARG (x.data ()), F77_CONST_DBLE_CMPLX_ARG (y.data ()),
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531) John W. Eaton <jwe@octave.org> parents: 22133 diff changeset	159 F77_DBLE_CMPLX_ARG (z.fortran_vec ())));
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	160 retval = z;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	161 }
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	162 }
23585 570170b6eb09 maint: Deprecate is_float_type and replace with isfloat. Rik <rik@octave.org> parents: 23581 diff changeset	163 else if (argx.isfloat () && argy.isfloat ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	164 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	165 if (argx.is_single_type () \|\| argy.is_single_type ())
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	166 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	167 FloatNDArray x = argx.float_array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	168 FloatNDArray y = argy.float_array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	169 get_red_dims (dimx, dimy, dim, dimz, m, n, k);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	170 FloatNDArray z (dimz);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	171
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	172 F77_XFCN (sdot3, SDOT3, (m, n, k, x.data (), y.data (),
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	173 z.fortran_vec ()));
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	174 retval = z;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	175 }
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	176 else
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	177 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	178 NDArray x = argx.array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	179 NDArray y = argy.array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	180 get_red_dims (dimx, dimy, dim, dimz, m, n, k);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	181 NDArray z (dimz);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	182
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	183 F77_XFCN (ddot3, DDOT3, (m, n, k, x.data (), y.data (),
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	184 z.fortran_vec ()));
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	185 retval = z;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	186 }
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	187 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	188 else
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	189 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	190 // Non-optimized evaluation.
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	191 // FIXME: This may not do what the user expects.
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	192 // It might be more useful to issue a warning, or even an error, instead
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	193 // of calculating possibly garbage results.
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	194 // Think of the dot product of two int8 vectors where the multiplications
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	195 // exceed intmax.
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	196 octave_value_list tmp;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	197 tmp(1) = dim + 1;
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	198 tmp(0) = binary_op (octave_value::op_el_mul, argx, argy);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	199
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	200 tmp = Fsum (tmp, 1);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	201 if (! tmp.empty ())
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	202 retval = tmp(0);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	203 }
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	204
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	205 return retval;
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	206 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	207
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	208 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	209 %!assert (dot ([1, 2], [2, 3]), 8)
12788 9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	210
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	211 %!test
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	212 %! x = [2, 1; 2, 1];
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	213 %! y = [-0.5, 2; 0.5, -2];
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	214 %! assert (dot (x, y), [0 0]);
19141 25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	215 %! assert (dot (single (x), single (y)), single ([0 0]));
12788 9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	216
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	217 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	218 %! x = [1+i, 3-i; 1-i, 3-i];
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	219 %! assert (dot (x, x), [4, 20]);
19141 25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	220 %! assert (dot (single (x), single (x)), single ([4, 20]));
15239 a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	221
a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	222 %!test
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	223 %! x = int8 ([1, 2]);
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	224 %! y = int8 ([2, 3]);
15239 a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	225 %! assert (dot (x, y), 8);
a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	226
a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	227 %!test
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	228 %! x = int8 ([1, 2; 3, 4]);
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	229 %! y = int8 ([5, 6; 7, 8]);
15239 a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	230 %! assert (dot (x, y), [26 44]);
a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	231 %! assert (dot (x, y, 2), [17; 53]);
a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	232 %! assert (dot (x, y, 3), [5 12; 21 32]);
a38d5ed5b3d8 dot.cc: Segfault with integers (bug #37199) Max Brister <max@2bass.com> parents: 15195 diff changeset	233
26599 5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	234 ## This is, perhaps, surprising. Integer maximums and saturation mechanics
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	235 ## prevent accurate value from being calculated.
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	236 %!test
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	237 %! x = int8 ([127]);
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	238 %! assert (dot (x, x), 127);
5ab12183280d dot.cc: Call Fsum directly rather than using feval. Rik <rik@octave.org> parents: 26493 diff changeset	239
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22323 diff changeset	240 ## Test input validation
18636 60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	241 %!error dot ()
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	242 %!error dot (1)
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	243 %!error dot (1,2,3,4)
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	244 %!error <X and Y must be numeric> dot ({1,2}, [3,4])
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	245 %!error <X and Y must be numeric> dot ([1,2], {3,4})
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	246 %!error <sizes of X and Y must match> dot ([1 2], [1 2 3])
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	247 %!error <sizes of X and Y must match> dot ([1 2]', [1 2 3]')
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	248 %!error <sizes of X and Y must match> dot (ones (2,2), ones (2,3))
60562e5c8bfb Correctly validate arguments to dot function (bug #42061). Rik <rik@octave.org> parents: 17787 diff changeset	249 %!error <DIM must be a valid dimension> dot ([1 2], [1 2], 0)
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	250 */
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	251
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	252 template <typename T>
29997 58f3f8b086f4 * dot.cc (blkmm_internal): Make internal functions static. John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	253 static void
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	254 blkmm_internal (const T& x, const T& y, T& z,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	255 F77_INT m, F77_INT n, F77_INT k, F77_INT np);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	256
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	257 template <>
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	258 void
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	259 blkmm_internal (const FloatComplexNDArray& x, const FloatComplexNDArray& y,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	260 FloatComplexNDArray& z,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	261 F77_INT m, F77_INT n, F77_INT k, F77_INT np)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	262 {
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	263 F77_XFCN (cmatm3, CMATM3, (m, n, k, np,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	264 F77_CONST_CMPLX_ARG (x.data ()),
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	265 F77_CONST_CMPLX_ARG (y.data ()),
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	266 F77_CMPLX_ARG (z.fortran_vec ())));
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	267 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	268
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	269 template <>
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	270 void
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	271 blkmm_internal (const ComplexNDArray& x, const ComplexNDArray& y,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	272 ComplexNDArray& z,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	273 F77_INT m, F77_INT n, F77_INT k, F77_INT np)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	274 {
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	275 F77_XFCN (zmatm3, ZMATM3, (m, n, k, np,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	276 F77_CONST_DBLE_CMPLX_ARG (x.data ()),
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	277 F77_CONST_DBLE_CMPLX_ARG (y.data ()),
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	278 F77_DBLE_CMPLX_ARG (z.fortran_vec ())));
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	279 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	280
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	281 template <>
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	282 void
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	283 blkmm_internal (const FloatNDArray& x, const FloatNDArray& y, FloatNDArray& z,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	284 F77_INT m, F77_INT n, F77_INT k, F77_INT np)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	285 {
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	286 F77_XFCN (smatm3, SMATM3, (m, n, k, np,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	287 x.data (), y.data (),
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	288 z.fortran_vec ()));
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	289 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	290
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	291 template <>
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	292 void
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	293 blkmm_internal (const NDArray& x, const NDArray& y, NDArray& z,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	294 F77_INT m, F77_INT n, F77_INT k, F77_INT np)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	295 {
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	296 F77_XFCN (dmatm3, DMATM3, (m, n, k, np,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	297 x.data (), y.data (),
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	298 z.fortran_vec ()));
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	299 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	300
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	301 static void
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	302 get_blkmm_dims (const dim_vector& dimx, const dim_vector& dimy,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	303 F77_INT& m, F77_INT& n, F77_INT& k, F77_INT& np,
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	304 dim_vector& dimz)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	305 {
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	306 int nd = dimx.ndims ();
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	307
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	308 m = to_f77_int (dimx(0));
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	309 k = to_f77_int (dimx(1));
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	310 n = to_f77_int (dimy(1));
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	311
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	312 octave_idx_type tmp_np = 1;
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	313
26493 bc6237a189e1 dot.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	314 bool match = ((dimy(0) == k) && (nd == dimy.ndims ()));
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	315
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	316 dimz = dim_vector::alloc (nd);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	317
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	318 dimz(0) = m;
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	319 dimz(1) = n;
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	320 for (int i = 2; match && i < nd; i++)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	321 {
26493 bc6237a189e1 dot.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	322 match = (dimx(i) == dimy(i));
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	323 dimz(i) = dimx(i);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	324 tmp_np *= dimz(i);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	325 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	326
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	327 np = to_f77_int (tmp_np);
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	328
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	329 if (! match)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	330 error ("blkmm: A and B dimensions don't match: (%s) and (%s)",
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	331 dimx.str ().c_str (), dimy.str ().c_str ());
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	332 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	333
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	334 template <typename T>
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	335 T
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	336 do_blkmm (const octave_value& xov, const octave_value& yov)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	337 {
25606 959657cab846 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 25567 diff changeset	338 const T x = octave_value_extract<T> (xov);
959657cab846 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 25567 diff changeset	339 const T y = octave_value_extract<T> (yov);
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	340 F77_INT m, n, k, np;
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	341 dim_vector dimz;
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	342
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	343 get_blkmm_dims (x.dims (), y.dims (), m, n, k, np, dimz);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	344
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	345 T z (dimz);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	346
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	347 if (n != 0 && m != 0)
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	348 blkmm_internal<T> (x, y, z, m, n, k, np);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	349
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	350 return z;
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	351 }
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	352
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	353 DEFUN (blkmm, 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	354 doc: /* -- texinfo --
30888 32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/ Rik <rik@octave.org> parents: 30723 diff changeset	355 @deftypefn {} {@var{C} =} blkmm (@var{A}, @var{B})
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	356 Compute products of matrix blocks.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	357
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	358 The blocks are given as 2-dimensional subarrays of the arrays @var{A},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	359 @var{B}. The size of @var{A} must have the form @code{[m,k,@dots{}]} and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	360 size of @var{B} must be @code{[k,n,@dots{}]}. The result is then of size
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	361 @code{[m,n,@dots{}]} and is computed as follows:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	362
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	363 @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 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	365 for i = 1:prod (size (@var{A})(3:end))
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	366 @var{C}(:,:,i) = @var{A}(:,:,i) * @var{B}(:,:,i)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	367 endfor
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	368 @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	369 @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	370 @end deftypefn */)
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	371 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20802 diff changeset	372 if (args.length () != 2)
20802 8bb38ba1bad6 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20556 diff changeset	373 print_usage ();
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	374
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	375 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	376
18100 6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	377 octave_value argx = args(0);
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp. Rik <rik@octave.org> parents: 17787 diff changeset	378 octave_value argy = args(1);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	379
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23585 diff changeset	380 if (! argx.isnumeric () \|\| ! argy.isnumeric ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	381 error ("blkmm: A and B must be numeric");
20556 4bed806ee3d4 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20218 diff changeset	382
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23220 diff changeset	383 if (argx.iscomplex () \|\| argy.iscomplex ())
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	384 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	385 if (argx.is_single_type () \|\| argy.is_single_type ())
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	386 retval = do_blkmm<FloatComplexNDArray> (argx, argy);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	387 else
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	388 retval = do_blkmm<ComplexNDArray> (argx, argy);
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	389 }
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	390 else
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	391 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	392 if (argx.is_single_type () \|\| argy.is_single_type ())
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	393 retval = do_blkmm<FloatNDArray> (argx, argy);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	394 else
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	395 retval = do_blkmm<NDArray> (argx, argy);
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	396 }
9874 90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	397
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	398 return retval;
90bc0cc4518f implement compiled dot and blkmm Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	399 }
12788 9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	400
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	401 /*
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	402 %!test
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	403 %! x(:,:,1) = [1 2; 3 4];
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	404 %! x(:,:,2) = [1 1; 1 1];
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	405 %! z(:,:,1) = [7 10; 15 22];
9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	406 %! z(:,:,2) = [2 2; 2 2];
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	407 %! assert (blkmm (x,x), z);
19141 25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	408 %! assert (blkmm (single (x), single (x)), single (z));
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	409 %! assert (blkmm (x, single (x)), single (z));
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	410
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	411 %!test
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	412 %! x(:,:,1) = [1 2; 3 4];
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	413 %! x(:,:,2) = [1i 1i; 1i 1i];
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	414 %! z(:,:,1) = [7 10; 15 22];
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	415 %! z(:,:,2) = [-2 -2; -2 -2];
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	416 %! assert (blkmm (x,x), z);
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	417 %! assert (blkmm (single (x), single (x)), single (z));
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	418 %! assert (blkmm (x, single (x)), single (z));
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	419
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	420 %!test <*54261>
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	421 %! x = ones (0, 3, 3);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	422 %! y = ones (3, 5, 3);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	423 %! z = blkmm (x,y);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	424 %! assert (size (z), [0, 5, 3]);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	425 %! x = ones (1, 3, 3);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	426 %! y = ones (3, 0, 3);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	427 %! z = blkmm (x,y);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	428 %! assert (size (z), [1, 0, 3]);
8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	429
22737 7abc25e6206a maint: Clean up code base to follow Octave coding conventions. Rik <rik@octave.org> parents: 22323 diff changeset	430 ## Test input validation
19141 25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	431 %!error blkmm ()
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	432 %!error blkmm (1)
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	433 %!error blkmm (1,2,3)
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	434 %!error <A and B must be numeric> blkmm ({1,2}, [3,4])
25ab600d16fd codesprint: Add %!tests for dot.cc file. Rik <rik@octave.org> parents: 18671 diff changeset	435 %!error <A and B must be numeric> blkmm ([3,4], {1,2})
25567 8c0a35040974 Fix blkmm to work with empty matrices (bug #54261). John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	436 %!error <A and B dimensions don't match> blkmm (ones (2,2), ones (3,3))
12788 9f4b48b93f6d codesprint: Write test for dot.cc Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12642 diff changeset	437 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	438
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30888 diff changeset	439 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

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