octave: libinterp/corefcn/typecast.cc annotate

annotate libinterp/corefcn/typecast.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	08b08b7f05b2
children	aac27ad79be6

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: 29961 diff changeset	3 // Copyright (C) 2007-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 ////////////////////////////////////////////////////////////////////////
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman 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"
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	28 #endif
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	29
25621 0fa7312e34bc Accept case insensitive second argument to typecast for Matlab compatibility (bug #54313). Rik <rik@octave.org> parents: 25088 diff changeset	30 #include <algorithm>
17396 0b644adf4f31 speak CHAR_BIT in C++-ese John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	31 #include <limits>
15289 27bdffcb41c5 typecast.cc: Include <climits> for CHAR_BIT. Júlio Hoffimann <julio.hoffimann@gmail.com>* parents: 15195 diff changeset	32
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	33 #include "mx-base.h"
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	34
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14360 diff changeset	35 #include "defun.h"
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	36 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20982 diff changeset	37 #include "errwarn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	38 #include "ovl.h"
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	39 #include "unwind-prot.h"
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	40
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30723 diff changeset	41 OCTAVE_BEGIN_NAMESPACE(octave)
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29931 diff changeset	42
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	43 static dim_vector
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	44 get_vec_dims (const dim_vector& old_dims, octave_idx_type n)
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	45 {
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21389 diff changeset	46 if (old_dims.ndims () == 2 && old_dims(0) == 1)
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	47 return dim_vector (1, n);
21660 53728df3e4c9 maint: for clarity, call ndims() rather than length() on dimension vectors. Rik <rik@octave.org> parents: 21389 diff changeset	48 else if (old_dims.ndims () == 2 && old_dims(0) == 0 && old_dims(1) == 0)
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	49 return dim_vector ();
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	50 else
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	51 return dim_vector (n, 1);
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	52 }
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	53
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21100 diff changeset	54 template <typename ArrayType>
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11572 diff changeset	55 static void
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	56 get_data_and_bytesize (const ArrayType& array,
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	57 const void *& data,
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	58 octave_idx_type& byte_size,
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9758 diff changeset	59 dim_vector& old_dims,
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	60 unwind_protect& frame)
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	61 {
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	62 // The array given may be a temporary, constructed from a scalar or sparse
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	63 // array. This will ensure the data will be deallocated after we exit.
10066 2cd940306a06 make unwind_protect frames local Jaroslav Hajek <highegg@gmail.com> parents: 9758 diff changeset	64 frame.add_delete (new ArrayType (array));
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	65
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	66 data = reinterpret_cast<const void *> (array.data ());
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	67 byte_size = array.byte_size ();
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	68
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	69 old_dims = array.dims ();
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	70 }
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	71
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21100 diff changeset	72 template <typename ArrayType>
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	73 static ArrayType
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	74 reinterpret_copy (const void *data, octave_idx_type byte_size,
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	75 const dim_vector& old_dims)
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	76 {
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	77 typedef typename ArrayType::element_type T;
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	78 octave_idx_type n = byte_size / sizeof (T);
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	79
20982 d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	80 if (n * static_cast<int> (sizeof (T)) != byte_size)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20800 diff changeset	81 error ("typecast: incorrect number of input values to make output value");
35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20800 diff changeset	82
20982 d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	83 ArrayType retval (get_vec_dims (old_dims, n));
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	84 T *dest = retval.fortran_vec ();
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	85 std::memcpy (dest, data, n * sizeof (T));
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	86
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	87 return retval;
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	88 }
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	89
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	90 template <typename ArrayType>
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	91 static ArrayType
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	92 reinterpret_int_copy (const void *data, octave_idx_type byte_size,
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	93 const dim_vector& old_dims)
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	94 {
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	95 typedef typename ArrayType::element_type T;
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	96 typedef typename T::val_type VT;
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	97 octave_idx_type n = byte_size / sizeof (T);
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	98
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	99 if (n * static_cast<int> (sizeof (T)) != byte_size)
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	100 error ("typecast: incorrect number of input values to make output value");
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	101
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	102 ArrayType retval (get_vec_dims (old_dims, n));
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	103 VT dest = reinterpret_cast<VT > (retval.fortran_vec ());
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	104 std::memcpy (dest, data, n * sizeof (VT));
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	105
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	106 return retval;
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	107 }
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	108
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14360 diff changeset	109 DEFUN (typecast, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	110 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	111 @deftypefn {} {@var{y} =} typecast (@var{x}, "@var{class}")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	112 Return a new array @var{y} resulting from interpreting the data of @var{x}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	113 in memory as data of the numeric class @var{class}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	114
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	115 Both the class of @var{x} and @var{class} must be one of the built-in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	116 numeric classes:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	117
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	118 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	119 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	120 "logical"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	121 "char"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	122 "int8"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	123 "int16"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	124 "int32"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	125 "int64"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	126 "uint8"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	127 "uint16"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	128 "uint32"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	129 "uint64"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	130 "double"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	131 "single"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	132 "double complex"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	133 "single complex"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	134 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	135 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	136
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	137 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	138 the last two are only used with @var{class}; they indicate that a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	139 complex-valued result is requested. Complex arrays are stored in memory as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	140 consecutive pairs of real numbers. The sizes of integer types are given by
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	141 their bit counts. Both logical and char are typically one byte wide;
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	142 however, this is not guaranteed by C++. If your system is IEEE conformant,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	143 single and double will be 4 bytes and 8 bytes wide, respectively.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	144 @qcode{"logical"} is not allowed for @var{class}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	145
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	146 If the input is a row vector, the return value is a row vector, otherwise it
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	147 is a column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	148
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	149 If the bit length of @var{x} is not divisible by that of @var{class}, an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	150 error occurs.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	151
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	152 An example of the use of typecast on a little-endian machine is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	153
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	154 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	155 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	156 @var{x} = uint16 ([1, 65535]);
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	157 typecast (@var{x}, "uint8")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	158 @result{} [ 1, 0, 255, 255]
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	159 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	160 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	161 @seealso{cast, bitpack, bitunpack, swapbytes}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	162 @end deftypefn */)
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	163 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	164 if (args.length () != 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	165 print_usage ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	166
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	167 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	168
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	169 unwind_protect frame;
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	170
23457 21baad6b35c4 maint: Use C++11 nullptr rather than 0 or NULL when possible. Rik <rik@octave.org> parents: 23220 diff changeset	171 const void *data = nullptr;
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	172 octave_idx_type byte_size = 0;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	173 dim_vector old_dims;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	174
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	175 octave_value array = args(0);
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	176
23579 c20a0fa91c0c maint: Deprecate is_bool_type and replace with islogical. Rik <rik@octave.org> parents: 23457 diff changeset	177 if (array.islogical ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	178 get_data_and_bytesize (array.bool_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	179 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	180 else if (array.is_string ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	181 get_data_and_bytesize (array.char_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	182 old_dims, frame);
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	183 else if (array.isinteger ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	184 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	185 if (array.is_int8_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	186 get_data_and_bytesize (array.int8_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	187 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	188 else if (array.is_int16_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	189 get_data_and_bytesize (array.int16_array_value (), data, byte_size,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	190 old_dims, frame);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	191 else if (array.is_int32_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	192 get_data_and_bytesize (array.int32_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	193 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	194 else if (array.is_int64_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	195 get_data_and_bytesize (array.int64_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	196 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	197 else if (array.is_uint8_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	198 get_data_and_bytesize (array.uint8_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	199 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	200 else if (array.is_uint16_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	201 get_data_and_bytesize (array.uint16_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	202 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	203 else if (array.is_uint32_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	204 get_data_and_bytesize (array.uint32_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	205 old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	206 else if (array.is_uint64_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	207 get_data_and_bytesize (array.uint64_array_value (), data, byte_size,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	208 old_dims, frame);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	209 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	210 else if (array.iscomplex ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	211 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	212 if (array.is_single_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	213 get_data_and_bytesize (array.float_complex_array_value (), data,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	214 byte_size, old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	215 else
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	216 get_data_and_bytesize (array.complex_array_value (), data,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	217 byte_size, old_dims, frame);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	218 }
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	219 else if (array.isreal ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	220 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	221 if (array.is_single_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	222 get_data_and_bytesize (array.float_array_value (), data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	223 old_dims, frame);
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	224 else
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	225 get_data_and_bytesize (array.array_value (), data, byte_size,
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	226 old_dims, frame);
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	227 }
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	228 else
22778 093b49ac544e maint: Capitalize variable names appearing in error() messages of C++ files. Rik <rik@octave.org> parents: 22755 diff changeset	229 error ("typecast: invalid input CLASS: %s",
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	230 array.class_name ().c_str ());
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	231
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	232 std::string numclass = args(1).string_value ();
25621 0fa7312e34bc Accept case insensitive second argument to typecast for Matlab compatibility (bug #54313). Rik <rik@octave.org> parents: 25088 diff changeset	233 std::transform (numclass.begin (), numclass.end (), numclass.begin (),
0fa7312e34bc Accept case insensitive second argument to typecast for Matlab compatibility (bug #54313). Rik <rik@octave.org> parents: 25088 diff changeset	234 tolower);
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	235
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	236 if (numclass.size () == 0)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	237 ;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	238 else if (numclass == "char")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	239 retval = octave_value (reinterpret_copy<charNDArray>
30346 91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 29961 diff changeset	240 (data, byte_size, old_dims),
91c6288781ba maint: Shorten some long lines in libinterp to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 29961 diff changeset	241 array.is_dq_string () ? '"' : '\'');
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	242 else if (numclass[0] == 'i')
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	243 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	244 if (numclass == "int8")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	245 retval = reinterpret_int_copy<int8NDArray> (data, byte_size, old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	246 else if (numclass == "int16")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	247 retval = reinterpret_int_copy<int16NDArray> (data, byte_size, old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	248 else if (numclass == "int32")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	249 retval = reinterpret_int_copy<int32NDArray> (data, byte_size, old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	250 else if (numclass == "int64")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	251 retval = reinterpret_int_copy<int64NDArray> (data, byte_size, old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	252 }
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	253 else if (numclass[0] == 'u')
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	254 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	255 if (numclass == "uint8")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	256 retval = reinterpret_int_copy<uint8NDArray> (data, byte_size, old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	257 else if (numclass == "uint16")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	258 retval = reinterpret_int_copy<uint16NDArray> (data, byte_size,
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	259 old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	260 else if (numclass == "uint32")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	261 retval = reinterpret_int_copy<uint32NDArray> (data, byte_size,
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	262 old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	263 else if (numclass == "uint64")
25088 56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	264 retval = reinterpret_int_copy<uint64NDArray> (data, byte_size,
56e888cd8298 avoid cast warnings from GCC 8 (bug #53544) John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	265 old_dims);
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	266 }
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	267 else if (numclass == "single")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	268 retval = reinterpret_copy<FloatNDArray> (data, byte_size, old_dims);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	269 else if (numclass == "double")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	270 retval = reinterpret_copy<NDArray> (data, byte_size, old_dims);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	271 else if (numclass == "single complex")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	272 retval = reinterpret_copy<FloatComplexNDArray> (data, byte_size,
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	273 old_dims);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	274 else if (numclass == "double complex")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	275 retval = reinterpret_copy<ComplexNDArray> (data, byte_size, old_dims);
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	276
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	277 if (retval.is_undefined ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	278 error ("typecast: cannot convert to %s class", numclass.c_str ());
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	279
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	280 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	281 }
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	282
21389 64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	283 /*
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	284 %!assert (typecast (int64 (0), "char"), char (zeros (1, 8)))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	285 %!assert (typecast (int64 (0), "int8"), zeros (1, 8, "int8"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	286 %!assert (typecast (int64 (0), "uint8"), zeros (1, 8, "uint8"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	287 %!assert (typecast (int64 (0), "int16"), zeros (1, 4, "int16"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	288 %!assert (typecast (int64 (0), "uint16"), zeros (1, 4, "uint16"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	289 %!assert (typecast (int64 (0), "int32"), zeros (1, 2, "int32"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	290 %!assert (typecast (int64 (0), "uint32"), zeros (1, 2, "uint32"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	291 %!assert (typecast (int64 (0), "int64"), zeros (1, 1, "int64"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	292 %!assert (typecast (int64 (0), "uint64"), zeros (1, 1, "uint64"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	293 %!assert (typecast (int64 (0), "single"), zeros (1, 2, "single"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	294 %!assert (typecast (int64 (0), "double"), 0)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	295 %!assert (typecast (int64 (0), "single complex"), single (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	296 %!assert (typecast (int64 ([0 0]), "double complex"), 0)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	297
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	298 %!assert (typecast ([], "double"), [])
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	299 %!assert (typecast (0, "double"), 0)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	300 %!assert (typecast (inf, "double"), inf)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	301 %!assert (typecast (-inf, "double"), -inf)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	302 %!assert (typecast (nan, "double"), nan)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	303
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	304 %!error typecast ()
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	305 %!error typecast (1)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	306 %!error typecast (1, 2, 3)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	307 %!error typecast (1, "invalid")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	308 %!error typecast (int8 (0), "double")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	309 */
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	310
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21100 diff changeset	311 template <typename ArrayType>
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	312 ArrayType
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	313 do_bitpack (const boolNDArray& bitp)
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	314 {
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	315 typedef typename ArrayType::element_type T;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	316 octave_idx_type n
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	317 = bitp.numel () / (sizeof (T) * std::numeric_limits<unsigned char>::digits);
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	318
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	319 if (n * static_cast<int> (sizeof (T)) *
34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	320 std::numeric_limits<unsigned char>::digits != bitp.numel ())
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20800 diff changeset	321 error ("bitpack: incorrect number of bits to make up output value");
35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20800 diff changeset	322
20982 d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	323 ArrayType retval (get_vec_dims (bitp.dims (), n));
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	324
29931 7faff48840eb prefer data over fortran_vec for read-only access to data John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	325 const bool *bits = bitp.data ();
20982 d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	326 char packed = reinterpret_cast<char > (retval.fortran_vec ());
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	327
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	328 octave_idx_type m = n * sizeof (T);
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	329
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	330 for (octave_idx_type i = 0; i < m; i++)
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	331 {
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	332 char c = bits[0];
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	333 for (int j = 1; j < std::numeric_limits<unsigned char>::digits; j++)
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	334 c \|= bits[j] << j;
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	335
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	336 packed[i] = c;
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	337 bits += std::numeric_limits<unsigned char>::digits;
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	338 }
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	339
d27f66b4b8e6 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20940 diff changeset	340 return retval;
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	341 }
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	342
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14360 diff changeset	343 DEFUN (bitpack, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	344 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	345 @deftypefn {} {@var{y} =} bitpack (@var{x}, @var{class})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	346 Return a new array @var{y} resulting from interpreting the logical array
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	347 @var{x} as raw bit patterns for data of the numeric class @var{class}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	348
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	349 @var{class} must be one of the built-in numeric classes:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	350
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	351 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	352 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	353 "double"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	354 "single"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	355 "double complex"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	356 "single complex"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	357 "char"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	358 "int8"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	359 "int16"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	360 "int32"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	361 "int64"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	362 "uint8"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	363 "uint16"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	364 "uint32"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	365 "uint64"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	366 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	367 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	368
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	369 The number of elements of @var{x} should be divisible by the bit length of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	370 @var{class}. If it is not, excess bits are discarded. Bits come in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	371 increasing order of significance, i.e., @code{x(1)} is bit 0, @code{x(2)} is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	372 bit 1, etc.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	373
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	374 The result is a row vector if @var{x} is a row vector, otherwise it is a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	375 column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	376 @seealso{bitunpack, typecast}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	377 @end deftypefn */)
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	378 {
19174 6f3e922c5197 doc: Improve docstrings for typecast, bitpack, bitunpack. Rik <rik@octave.org> parents: 17787 diff changeset	379 if (args.length () != 2)
6f3e922c5197 doc: Improve docstrings for typecast, bitpack, bitunpack. Rik <rik@octave.org> parents: 17787 diff changeset	380 print_usage ();
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	381
23579 c20a0fa91c0c maint: Deprecate is_bool_type and replace with islogical. Rik <rik@octave.org> parents: 23457 diff changeset	382 if (! args(0).islogical ())
19174 6f3e922c5197 doc: Improve docstrings for typecast, bitpack, bitunpack. Rik <rik@octave.org> parents: 17787 diff changeset	383 error ("bitpack: X must be a logical array");
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	384
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	385 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	386
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	387 boolNDArray bitp = args(0).bool_array_value ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	388
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	389 std::string numclass = args(1).string_value ();
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	390
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	391 if (numclass.size () == 0)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	392 ;
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	393 else if (numclass == "char")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	394 retval = octave_value (do_bitpack<charNDArray> (bitp), '\'');
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	395 else if (numclass[0] == 'i')
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	396 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	397 if (numclass == "int8")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	398 retval = do_bitpack<int8NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	399 else if (numclass == "int16")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	400 retval = do_bitpack<int16NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	401 else if (numclass == "int32")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	402 retval = do_bitpack<int32NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	403 else if (numclass == "int64")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	404 retval = do_bitpack<int64NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	405 }
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	406 else if (numclass[0] == 'u')
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	407 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	408 if (numclass == "uint8")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	409 retval = do_bitpack<uint8NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	410 else if (numclass == "uint16")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	411 retval = do_bitpack<uint16NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	412 else if (numclass == "uint32")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	413 retval = do_bitpack<uint32NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	414 else if (numclass == "uint64")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	415 retval = do_bitpack<uint64NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	416 }
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	417 else if (numclass == "single")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	418 retval = do_bitpack<FloatNDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	419 else if (numclass == "double")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	420 retval = do_bitpack<NDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	421 else if (numclass == "single complex")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	422 retval = do_bitpack<FloatComplexNDArray> (bitp);
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	423 else if (numclass == "double complex")
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	424 retval = do_bitpack<ComplexNDArray> (bitp);
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	425
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	426 if (retval.is_undefined ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	427 error ("bitpack: cannot pack to %s class", numclass.c_str ());
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	428
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	429 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	430 }
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	431
21389 64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	432 /*
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	433 %!assert (bitpack (zeros (1, 8, "logical"), "char"), "\0")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	434 %!assert (bitpack (zeros (1, 8, "logical"), "int8"), int8 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	435 %!assert (bitpack (zeros (1, 8, "logical"), "uint8"), uint8 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	436 %!assert (bitpack (zeros (1, 16, "logical"), "int16"), int16 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	437 %!assert (bitpack (zeros (1, 16, "logical"), "uint16"), uint16 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	438 %!assert (bitpack (zeros (1, 32, "logical"), "int32"), int32 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	439 %!assert (bitpack (zeros (1, 32, "logical"), "uint32"), uint32 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	440 %!assert (bitpack (zeros (1, 64, "logical"), "int64"), int64 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	441 %!assert (bitpack (zeros (1, 64, "logical"), "uint64"), uint64 (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	442 %!assert (bitpack (zeros (1, 32, "logical"), "single"), single (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	443 %!assert (bitpack (zeros (1, 64, "logical"), "double"), double (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	444 %!assert (bitpack (zeros (1, 64, "logical"), "single complex"), single (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	445 %!assert (bitpack (zeros (1, 128, "logical"), "double complex"), double (0))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	446
26049 09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	447 %!test <54931>
09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	448 %! x = false (1, 32);
09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	449 %! x(1) = true;
09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	450 %! assert (bitpack (x, "uint32"), uint32 (1));
09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	451 %! x([1, 9]) = true;
09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	452 %! assert (bitpack (x, "uint32"), uint32 (257));
09665529b6ba Add a BIST test for bitpack (bug #54931). Rik <rik@octave.org> parents: 25621 diff changeset	453
21389 64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	454 %!error bitpack ()
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	455 %!error bitpack (1)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	456 %!error bitpack (1, 2, 3)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	457 %!error bitpack (1, "invalid")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	458 %!error bitpack (1, "double")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	459 %!error bitpack (false, "invalid")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	460 %!error bitpack (false, "double")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	461 */
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	462
21139 538b57866b90 consistently use "typename" intead of "class" in template declarations John W. Eaton <jwe@octave.org> parents: 21100 diff changeset	463 template <typename ArrayType>
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	464 boolNDArray
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	465 do_bitunpack (const ArrayType& array)
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	466 {
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	467 typedef typename ArrayType::element_type T;
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	468 octave_idx_type n = array.numel () * sizeof (T)
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	469 * std::numeric_limits<unsigned char>::digits;
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	470
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	471 boolNDArray retval (get_vec_dims (array.dims (), n));
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	472
29931 7faff48840eb prefer data over fortran_vec for read-only access to data John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	473 const char packed = reinterpret_cast<const char > (array.data ());
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	474 bool *bits = retval.fortran_vec ();
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	475
17396 0b644adf4f31 speak CHAR_BIT in C++-ese John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	476 octave_idx_type m = n / std::numeric_limits<unsigned char>::digits;
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	477
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	478 for (octave_idx_type i = 0; i < m; i++)
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	479 {
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	480 char c = packed[i];
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	481 bits[0] = c & 1;
17396 0b644adf4f31 speak CHAR_BIT in C++-ese John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	482 for (int j = 1; j < std::numeric_limits<unsigned char>::digits; j++)
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	483 bits[j] = (c >>= 1) & 1;
17396 0b644adf4f31 speak CHAR_BIT in C++-ese John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	484 bits += std::numeric_limits<unsigned char>::digits;
6869 f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	485 }
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	486
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	487 return retval;
f9c893831e68 [project @ 2007-09-06 16:38:44 by dbateman] dbateman parents: diff changeset	488 }
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	489
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14360 diff changeset	490 DEFUN (bitunpack, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	491 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	492 @deftypefn {} {@var{y} =} bitunpack (@var{x})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	493 Return a logical array @var{y} corresponding to the raw bit patterns of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	494 @var{x}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	495
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	496 @var{x} must belong to one of the built-in numeric classes:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	497
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	498 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	499 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	500 "double"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	501 "single"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	502 "char"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	503 "int8"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	504 "int16"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	505 "int32"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	506 "int64"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	507 "uint8"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	508 "uint16"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	509 "uint32"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	510 "uint64"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	511 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	512 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	513
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	514 The result is a row vector if @var{x} is a row vector; otherwise, it is a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	515 column vector.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	516 @seealso{bitpack, typecast}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	517 @end deftypefn */)
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	518 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	519 if (args.length () != 1)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	520 print_usage ();
20921 4d3daf7e43f3 eliminate trailing whitespace in source files John W. Eaton <jwe@octave.org> parents: 20853 diff changeset	521
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23582 diff changeset	522 if (! (args(0).isnumeric () \|\| args(0).is_string ()))
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	523 error ("bitunpack: argument must be a number or a string");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	524
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	525 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20921 diff changeset	526
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	527 octave_value array = args(0);
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	528
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	529 if (array.is_string ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	530 retval = do_bitunpack (array.char_array_value ());
23580 2230f9e10fb3 maint: Deprecate is_integer_type and replace with isinteger. Rik <rik@octave.org> parents: 23579 diff changeset	531 else if (array.isinteger ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	532 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	533 if (array.is_int8_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	534 retval = do_bitunpack (array.int8_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	535 else if (array.is_int16_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	536 retval = do_bitunpack (array.int16_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	537 else if (array.is_int32_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	538 retval = do_bitunpack (array.int32_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	539 else if (array.is_int64_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	540 retval = do_bitunpack (array.int64_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	541 else if (array.is_uint8_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	542 retval = do_bitunpack (array.uint8_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	543 else if (array.is_uint16_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	544 retval = do_bitunpack (array.uint16_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	545 else if (array.is_uint32_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	546 retval = do_bitunpack (array.uint32_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	547 else if (array.is_uint64_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	548 retval = do_bitunpack (array.uint64_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	549 }
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23580 diff changeset	550 else if (array.iscomplex ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	551 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	552 if (array.is_single_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	553 retval = do_bitunpack (array.float_complex_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	554 else
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	555 retval = do_bitunpack (array.complex_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	556 }
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23581 diff changeset	557 else if (array.isreal ())
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	558 {
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	559 if (array.is_single_type ())
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	560 retval = do_bitunpack (array.float_array_value ());
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	561 else
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	562 retval = do_bitunpack (array.array_value ());
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	563 }
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	564 else
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	565 error ("bitunpack: invalid input class: %s",
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	566 array.class_name ().c_str ());
9671 e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	567
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	568 return retval;
e4b383a0effa merge reinterpret.cc into typecast.cc Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	569 }
21389 64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	570
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	571 /*
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	572 %!assert (bitunpack ("\0"), zeros (1, 8, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	573 %!assert (bitunpack (int8 (0)), zeros (1, 8, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	574 %!assert (bitunpack (uint8 (0)), zeros (1, 8, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	575 %!assert (bitunpack (int16 (0)), zeros (1, 16, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	576 %!assert (bitunpack (uint16 (0)), zeros (1, 16, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	577 %!assert (bitunpack (int32 (0)), zeros (1, 32, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	578 %!assert (bitunpack (uint32 (0)), zeros (1, 32, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	579 %!assert (bitunpack (int64 (0)), zeros (1, 64, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	580 %!assert (bitunpack (uint64 (0)), zeros (1, 64, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	581 %!assert (bitunpack (single (0)), zeros (1, 32, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	582 %!assert (bitunpack (double (0)), zeros (1, 64, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	583 %!assert (bitunpack (complex (single (0))), zeros (1, 64, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	584 %!assert (bitunpack (complex (double (0))), zeros (1, 128, "logical"))
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	585
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	586 %!error bitunpack ()
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	587 %!error bitunpack (1, 2)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	588 %!error bitunpack ({})
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast Mike Miller <mtmiller@octave.org> parents: 21301 diff changeset	589 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29931 diff changeset	590
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30723 diff changeset	591 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

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