octave: libinterp/corefcn/bitfcns.cc annotate

annotate libinterp/corefcn/bitfcns.cc @ 20918:6f0bd96f93c0

maint: Use new C++ archetype in more files. Place input validation first in files. Move declaration of retval down in function to be closer to point of usage. Eliminate else clause after if () error. Use "return ovl()" where it makes sense. * __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __lin_interpn__.cc, balance.cc, betainc.cc, bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, dirfns.cc, dlmread.cc, dot.cc, eig.cc, error.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, ov-type-conv.h: Use new C++ archetype in more files.

author	Rik <rik@octave.org>
date	Wed, 16 Dec 2015 15:00:31 -0800
parents	020b71557b12
children	81c2b14c209f

rev	line source
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	1 /*
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19201 diff changeset	3 Copyright (C) 2004-2015 John W. Eaton
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	4
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	6
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	10 option) any later version.
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	11
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	15 for more details.
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	16
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6678 diff changeset	19 <http://www.gnu.org/licenses/>.
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	20
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	21 */
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	22
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	23 #ifdef HAVE_CONFIG_H
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	24 #include <config.h>
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	25 #endif
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	26
17396 0b644adf4f31 speak CHAR_BIT in C++-ese John W. Eaton <jwe@octave.org> parents: 17392 diff changeset	27 #include <limits>
0b644adf4f31 speak CHAR_BIT in C++-ese John W. Eaton <jwe@octave.org> parents: 17392 diff changeset	28
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	29 #include "str-vec.h"
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	30 #include "quit.h"
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	31
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	32 #include "defun.h"
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	33 #include "error.h"
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	34 #include "ov.h"
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	35 #include "ov-uint64.h"
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	36 #include "ov-uint32.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	37 #include "ov-uint16.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	38 #include "ov-uint8.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	39 #include "ov-int64.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	40 #include "ov-int32.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	41 #include "ov-int16.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	42 #include "ov-int8.h"
17392 e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 17390 diff changeset	43 #include "ov-float.h"
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	44 #include "ov-scalar.h"
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	45 #include "ov-re-mat.h"
7763 0c6b4c7d7117 Treat bool as a scalar in the bit functions David Bateman <dbateman@free.fr> parents: 7097 diff changeset	46 #include "ov-bool.h"
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	47
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	48 #include <functional>
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	49
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20711 diff changeset	50 #if ! defined (HAVE_CXX_BITWISE_OP_TEMPLATES)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	51 namespace std
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	52 {
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	53 template <typename T>
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	54 struct bit_and
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	55 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	56 public:
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	57 T operator() (const T & op1, const T & op2) const { return (op1 & op2); }
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	58 };
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	59
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	60 template <typename T>
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	61 struct bit_or
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	62 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	63 public:
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	64 T operator() (const T & op1, const T & op2) const { return (op1 \| op2); }
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	65 };
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	66
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	67 template <typename T>
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	68 struct bit_xor
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	69 {
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	70 public:
14725 fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	71 T operator() (const T & op1, const T & op2) const { return (op1 ^ op2); }
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	72 };
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	73 }
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	74 #endif
fa48fd0f160f Add configure check for templated bitwise operators. Carlo de Falco <cdf@users.sourceforge.net> parents: 14631 diff changeset	75
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	76 template <typename OP, typename T>
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	77 octave_value
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	78 bitopxx (const OP& op, const std::string& fname,
f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	79 const Array<T>& x, const Array<T>& y)
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	80 {
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	81 int nelx = x.numel ();
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	82 int nely = y.numel ();
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	83
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	84 bool is_scalar_op = (nelx == 1 \|\| nely == 1);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	85
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	86 dim_vector dvx = x.dims ();
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	87 dim_vector dvy = y.dims ();
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	88
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	89 bool is_array_op = (dvx == dvy);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	90
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	91 octave_value retval;
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	92 if (is_array_op \|\| is_scalar_op)
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	93 {
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	94 Array<T> result;
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	95
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	96 if (nelx != 1)
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	97 result.resize (dvx);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	98 else
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	99 result.resize (dvy);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	100
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	101 for (int i = 0; i < nelx; i++)
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	102 if (is_scalar_op)
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	103 for (int k = 0; k < nely; k++)
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	104 result(i+k) = op (x(i), y(k));
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	105 else
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	106 result(i) = op (x(i), y(i));
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	107
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	108 retval = result;
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	109 }
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	110 else
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	111 error ("%s: size of X and Y must match, or one operand must be a scalar",
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14725 diff changeset	112 fname.c_str ());
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	113
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	114 return retval;
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	115 }
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	116
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	117 // Trampoline function, instantiates the proper template above, with
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	118 // reflective information hardwired. We can't hardwire this information
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	119 // in Fbitxxx DEFUNs below, because at that moment, we still don't have
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	120 // information about which integer types we need to instantiate.
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	121 template<typename T>
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	122 octave_value
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	123 bitopx (const std::string& fname, const Array<T>& x, const Array<T>& y)
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	124 {
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	125 if (fname == "bitand")
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	126 return bitopxx (std::bit_and<T>(), fname, x, y);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	127 if (fname == "bitor")
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	128 return bitopxx (std::bit_or<T>(), fname, x, y);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	129
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	130 //else (fname == "bitxor")
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	131 return bitopxx (std::bit_xor<T>(), fname, x, y);
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	132 }
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	133
19864 17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	134 static inline int
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	135 bitop_arg_is_int (const octave_value& arg)
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	136 {
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	137 return (arg.class_name () != octave_scalar::static_class_name ()
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	138 && arg.class_name () != octave_float_scalar::static_class_name ()
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	139 && arg.class_name () != octave_bool::static_class_name ());
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	140 }
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	141
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	142 static inline int
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	143 bitop_arg_is_bool (const octave_value& arg)
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	144 {
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	145 return arg.class_name () == octave_bool::static_class_name ();
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	146 }
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	147
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	148 static inline int
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	149 bitop_arg_is_float (const octave_value& arg)
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	150 {
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	151 return arg.class_name () == octave_float_scalar::static_class_name ();
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	152 }
17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	153
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	154 octave_value
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	155 bitop (const std::string& fname, const octave_value_list& args)
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	156 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	157 if (args.length () != 2)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	158 print_usage ();
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	159
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	160 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	161
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	162 if (args(0).class_name () == octave_scalar::static_class_name ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	163 \|\| args(0).class_name () == octave_float_scalar::static_class_name ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	164 \|\| args(0).class_name () == octave_bool::static_class_name ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	165 \|\| args(1).class_name () == octave_scalar::static_class_name ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	166 \|\| args(1).class_name () == octave_float_scalar::static_class_name ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	167 \|\| args(1).class_name () == octave_bool::static_class_name ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	168 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	169 bool arg0_is_int = bitop_arg_is_int (args(0));
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	170 bool arg1_is_int = bitop_arg_is_int (args(1));
19864 17d647821d61 maint: More cleanup of C++ code to follow Octave coding conventions. John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	171
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	172 bool arg0_is_bool = bitop_arg_is_bool (args(0));
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	173 bool arg1_is_bool = bitop_arg_is_bool (args(1));
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	174
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	175 bool arg0_is_float = bitop_arg_is_float (args(0));
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	176 bool arg1_is_float = bitop_arg_is_float (args(1));
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	177
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	178 if (! (arg0_is_int \|\| arg1_is_int))
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	179 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	180 if (arg0_is_bool && arg1_is_bool)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	181 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	182 boolNDArray x (args(0).bool_array_value ());
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	183 boolNDArray y (args(1).bool_array_value ());
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	184
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	185 retval = bitopx (fname, x, y).bool_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	186 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	187 else if (arg0_is_float && arg1_is_float)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	188 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	189 uint64NDArray x (args(0).float_array_value ());
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	190 uint64NDArray y (args(1).float_array_value ());
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	191
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	192 retval = bitopx (fname, x, y).float_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	193 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	194 else if (! (arg0_is_float \|\| arg1_is_float))
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	195 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	196 uint64NDArray x (args(0).array_value ());
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	197 uint64NDArray y (args(1).array_value ());
17392 e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 17390 diff changeset	198
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	199 retval = bitopx (fname, x, y).array_value ();
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	200 }
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	201 else
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	202 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	203 int p = (arg0_is_float ? 1 : 0);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	204 int q = (arg0_is_float ? 0 : 1);
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	205
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	206 uint64NDArray x (args(p).array_value ());
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	207 uint64NDArray y (args(q).float_array_value ());
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	208
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	209 retval = bitopx (fname, x, y).float_array_value ();
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	210 }
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	211 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	212 else
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	213 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	214 int p = (arg0_is_int ? 1 : 0);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	215 int q = (arg0_is_int ? 0 : 1);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	216
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	217 NDArray dx = args(p).array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	218
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	219 if (args(q).type_id () == octave_uint64_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	220 \|\| args(q).type_id () == octave_uint64_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	221 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	222 uint64NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	223 uint64NDArray y = args(q).uint64_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	224
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	225 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	226 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	227 else if (args(q).type_id () == octave_uint32_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	228 \|\| args(q).type_id () == octave_uint32_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	229 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	230 uint32NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	231 uint32NDArray y = args(q).uint32_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	232
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	233 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	234 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	235 else if (args(q).type_id () == octave_uint16_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	236 \|\| args(q).type_id () == octave_uint16_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	237 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	238 uint16NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	239 uint16NDArray y = args(q).uint16_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	240
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	241 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	242 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	243 else if (args(q).type_id () == octave_uint8_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	244 \|\| args(q).type_id () == octave_uint8_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	245 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	246 uint8NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	247 uint8NDArray y = args(q).uint8_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	248
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	249 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	250 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	251 else if (args(q).type_id () == octave_int64_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	252 \|\| args(q).type_id () == octave_int64_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	253 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	254 int64NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	255 int64NDArray y = args(q).int64_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	256
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	257 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	258 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	259 else if (args(q).type_id () == octave_int32_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	260 \|\| args(q).type_id () == octave_int32_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	261 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	262 int32NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	263 int32NDArray y = args(q).int32_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	264
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	265 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	266 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	267 else if (args(q).type_id () == octave_int16_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	268 \|\| args(q).type_id () == octave_int16_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	269 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	270 int16NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	271 int16NDArray y = args(q).int16_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	272
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	273 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	274 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	275 else if (args(q).type_id () == octave_int8_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	276 \|\| args(q).type_id () == octave_int8_scalar::static_type_id ())
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	277 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	278 int8NDArray x (dx);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	279 int8NDArray y = args(q).int8_array_value ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	280
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	281 retval = bitopx (fname, x, y);
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	282 }
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	283 else
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14725 diff changeset	284 error ("%s: invalid operand type", fname.c_str ());
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	285 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	286 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	287 else if (args(0).class_name () == args(1).class_name ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	288 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	289 if (args(0).type_id () == octave_uint64_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	290 \|\| args(0).type_id () == octave_uint64_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	291 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	292 uint64NDArray x = args(0).uint64_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	293 uint64NDArray y = args(1).uint64_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	294
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	295 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	296 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	297 else if (args(0).type_id () == octave_uint32_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	298 \|\| args(0).type_id () == octave_uint32_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	299 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	300 uint32NDArray x = args(0).uint32_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	301 uint32NDArray y = args(1).uint32_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	302
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	303 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	304 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	305 else if (args(0).type_id () == octave_uint16_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	306 \|\| args(0).type_id () == octave_uint16_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	307 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	308 uint16NDArray x = args(0).uint16_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	309 uint16NDArray y = args(1).uint16_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	310
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	311 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	312 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	313 else if (args(0).type_id () == octave_uint8_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	314 \|\| args(0).type_id () == octave_uint8_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	315 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	316 uint8NDArray x = args(0).uint8_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	317 uint8NDArray y = args(1).uint8_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	318
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	319 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	320 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	321 else if (args(0).type_id () == octave_int64_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	322 \|\| args(0).type_id () == octave_int64_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	323 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	324 int64NDArray x = args(0).int64_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	325 int64NDArray y = args(1).int64_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	326
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	327 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	328 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	329 else if (args(0).type_id () == octave_int32_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	330 \|\| args(0).type_id () == octave_int32_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	331 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	332 int32NDArray x = args(0).int32_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	333 int32NDArray y = args(1).int32_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	334
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	335 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	336 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	337 else if (args(0).type_id () == octave_int16_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	338 \|\| args(0).type_id () == octave_int16_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	339 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	340 int16NDArray x = args(0).int16_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	341 int16NDArray y = args(1).int16_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	342
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	343 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	344 }
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	345 else if (args(0).type_id () == octave_int8_matrix::static_type_id ()
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	346 \|\| args(0).type_id () == octave_int8_scalar::static_type_id ())
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	347 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	348 int8NDArray x = args(0).int8_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	349 int8NDArray y = args(1).int8_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	350
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	351 retval = bitopx (fname, x, y);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	352 }
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	353 else
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	354 error ("%s: invalid operand type", fname.c_str ());
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	355 }
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	356 else
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	357 error ("%s: must have matching operand types", fname.c_str ());
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	358
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	359 return retval;
57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	360 }
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	361
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	362 DEFUN (bitand, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	363 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	364 @deftypefn {} {} bitand (@var{x}, @var{y})\n\
9209 923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction. Rik <rdrider0-list@yahoo.com> parents: 9064 diff changeset	365 Return the bitwise AND of non-negative integers.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	366 \n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	367 @var{x}, @var{y} must be in the range [0,intmax]\n\
4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	368 @seealso{bitor, bitxor, bitset, bitget, bitcmp, bitshift, intmax, flintmax}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	369 @end deftypefn")
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	370 {
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	371 return bitop ("bitand", args);
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	372 }
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	373
20870 020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	374 /*
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	375 %!# Function bitand is tested as part of bitxor BIST tests
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	376 */
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	377
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	378 DEFUN (bitor, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	379 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	380 @deftypefn {} {} bitor (@var{x}, @var{y})\n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	381 Return the bitwise OR of non-negative integers @var{x} and @var{y}.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	382 \n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	383 @seealso{bitor, bitxor, bitset, bitget, bitcmp, bitshift, intmax, flintmax}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	384 @end deftypefn")
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	385 {
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	386 return bitop ("bitor", args);
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	387 }
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	388
20870 020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	389 /*
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	390 %!# Function bitor is tested as part of bitxor BIST tests
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	391 */
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	392
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	393 DEFUN (bitxor, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	394 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	395 @deftypefn {} {} bitxor (@var{x}, @var{y})\n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	396 Return the bitwise XOR of non-negative integers @var{x} and @var{y}.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	397 \n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	398 @seealso{bitand, bitor, bitset, bitget, bitcmp, bitshift, intmax, flintmax}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	399 @end deftypefn")
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	400 {
14631 57e4ff70b7c1 Use more templates in bitwise operators. Death to macros! ☠ Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	401 return bitop ("bitxor", args);
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	402 }
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	403
19146 a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	404 /*
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	405 %!assert (bitand (true, false), false)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	406 %!assert (bitor (true, false), true)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	407 %!assert (bitxor (true, false), true)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	408
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	409 %!assert (bitand (true, true), true)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	410 %!assert (bitor (true, true), true)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	411 %!assert (bitxor (true, true), false)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	412
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	413 %!assert (bitand (true, 5), 1)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	414
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	415 %!assert (bitand (true, false), false)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	416 %!assert (bitand (true, true), true)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	417 %!assert (bitand (true, false), false)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	418 %!assert (bitand (true, false), false)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	419
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	420 ## Test idx_arg.length () == 0
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	421 %!error <size of X and Y must match> bitand ([0 0 0], [1 0])
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	422 %!error <size of X and Y must match> bitand ([0; 0; 0], [0 0 0])
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	423 */
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	424
17389 dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	425 template <typename T>
dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	426 static int64_t
dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	427 max_mantissa_value ()
dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	428 {
dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	429 return (static_cast<int64_t> (1) << std::numeric_limits<T>::digits) - 1;
dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	430 }
dbdff94bf977 Use std::numeric_limits for floating point bit widths Mike Miller <mtmiller@ieee.org> parents: 17281 diff changeset	431
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	432 static int64_t
22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	433 bitshift (double a, int n, int64_t mask)
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	434 {
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5828 diff changeset	435 // In the name of bug-for-bug compatibility.
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5828 diff changeset	436 if (a < 0)
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5828 diff changeset	437 return -bitshift (-a, n, mask);
143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5828 diff changeset	438
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	439 if (n > 0)
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	440 return (static_cast<int64_t> (a) << n) & mask;
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	441 else if (n < 0)
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	442 return (static_cast<int64_t> (a) >> -n) & mask;
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	443 else
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	444 return static_cast<int64_t> (a) & mask;
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	445 }
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	446
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	447 static int64_t
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	448 bitshift (float a, int n, int64_t mask)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	449 {
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	450 // In the name of bug-for-bug compatibility.
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	451 if (a < 0)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	452 return -bitshift (-a, n, mask);
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	453
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	454 if (n > 0)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	455 return (static_cast<int64_t> (a) << n) & mask;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	456 else if (n < 0)
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	457 return (static_cast<int64_t> (a) >> -n) & mask;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	458 else
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	459 return static_cast<int64_t> (a) & mask;
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	460 }
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7763 diff changeset	461
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	462 // Note that the bitshift operators are undefined if shifted by more
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	463 // bits than in the type, so we need to test for the size of the
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	464 // shift.
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	465
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	466 #define DO_BITSHIFT(T) \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	467 double d1, d2; \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	468 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	469 if (n.all_integers (d1, d2)) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	470 { \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	471 int m_nel = m.numel (); \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	472 int n_nel = n.numel (); \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	473 \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	474 bool is_scalar_op = (m_nel == 1 \|\| n_nel == 1); \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	475 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	476 dim_vector m_dv = m.dims (); \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	477 dim_vector n_dv = n.dims (); \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	478 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	479 bool is_array_op = (m_dv == n_dv); \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	480 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	481 if (is_array_op \|\| is_scalar_op) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	482 { \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	483 T ## NDArray result; \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	484 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	485 if (m_nel != 1) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	486 result.resize (m_dv); \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	487 else \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	488 result.resize (n_dv); \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	489 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	490 for (int i = 0; i < m_nel; i++) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	491 if (is_scalar_op) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	492 for (int k = 0; k < n_nel; k++) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	493 if (static_cast<int> (n(k)) >= bits_in_type) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	494 result(i+k) = 0; \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	495 else \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	496 result(i+k) = bitshift (m(i), static_cast<int> (n(k)), mask); \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	497 else \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	498 if (static_cast<int> (n(i)) >= bits_in_type) \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	499 result(i) = 0; \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	500 else \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	501 result(i) = bitshift (m(i), static_cast<int> (n(i)), mask); \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	502 \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	503 retval = result; \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	504 } \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	505 else \
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	506 error ("bitshift: size of A and N must match, or one operand must be a scalar"); \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	507 } \
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20486 diff changeset	508 else \
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	509 error ("bitshift: K must be a scalar or array of integers"); \
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	510
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	511 #define DO_UBITSHIFT(T, N) \
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	512 do \
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	513 { \
4920 b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe] jwe parents: 4919 diff changeset	514 int bits_in_type = octave_ ## T :: nbits (); \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	515 T ## NDArray m = m_arg.T ## _array_value (); \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	516 octave_ ## T mask = octave_ ## T::max (); \
4920 b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe] jwe parents: 4919 diff changeset	517 if ((N) < bits_in_type) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	518 mask = bitshift (mask, (N) - bits_in_type); \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	519 else if ((N) < 1) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	520 mask = 0; \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	521 DO_BITSHIFT (T); \
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	522 } \
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	523 while (0)
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	524
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	525 #define DO_SBITSHIFT(T, N) \
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	526 do \
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	527 { \
4920 b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe] jwe parents: 4919 diff changeset	528 int bits_in_type = octave_ ## T :: nbits (); \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	529 T ## NDArray m = m_arg.T ## _array_value (); \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	530 octave_ ## T mask = octave_ ## T::max (); \
4920 b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe] jwe parents: 4919 diff changeset	531 if ((N) < bits_in_type) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	532 mask = bitshift (mask, (N) - bits_in_type); \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	533 else if ((N) < 1) \
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	534 mask = 0; \
9440 357cff83985d fix signed integer shift Jaroslav Hajek <highegg@gmail.com> parents: 9209 diff changeset	535 mask = mask \| octave_ ## T :: min (); /* FIXME: 2's complement only? */ \
4919 a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	536 DO_BITSHIFT (T); \
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe] jwe parents: 4915 diff changeset	537 } \
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	538 while (0)
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	539
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	540 DEFUN (bitshift, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	541 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	542 @deftypefn {} {} bitshift (@var{a}, @var{k})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	543 @deftypefnx {} {} bitshift (@var{a}, @var{k}, @var{n})\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	544 Return a @var{k} bit shift of @var{n}-digit unsigned integers in @var{a}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	545 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	546 A positive @var{k} leads to a left shift; A negative value to a right shift.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	547 \n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	548 If @var{n} is omitted it defaults to 64.\n\
4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	549 @var{n} must be in the range [1,64].\n\
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	550 \n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	551 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	552 @group\n\
7097 e8c94e473c68 [project @ 2007-11-02 17:24:23 by jwe] jwe parents: 7017 diff changeset	553 bitshift (eye (3), 1)\n\
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	554 @result{}\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	555 @group\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	556 2 0 0\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	557 0 2 0\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	558 0 0 2\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	559 @end group\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	560 \n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	561 bitshift (10, [-2, -1, 0, 1, 2])\n\
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	562 @result{} 2 5 10 20 40\n\
17861 870f3e12e163 maint: Use phrase "FIXME:" for problem areas in code. Rik <rik@octave.org> parents: 17787 diff changeset	563 @c FIXME: restore this example when third arg is allowed to be an array.\n\
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	564 @c\n\
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 12483 diff changeset	565 @c\n\
6439 a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe] jwe parents: 6108 diff changeset	566 @c bitshift ([1, 10], 2, [3,4])\n\
a37c427ae9d1 [project @ 2007-03-23 15:04:01 by jwe] jwe parents: 6108 diff changeset	567 @c @result{} 4 8\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	568 @end group\n\
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	569 @end example\n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	570 @seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, intmax, flintmax}\n\
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	571 @end deftypefn")
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	572 {
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	573 int nargin = args.length ();
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	574
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	575 if (nargin < 2 \|\| nargin > 3)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	576 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	577
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	578 NDArray n = args(1).xarray_value ("bitshift: K must be a scalar or array of integers");
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	579
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	580 int nbits = 64;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	581
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	582 if (nargin == 3)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	583 {
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	584 // FIXME: for compatibility, we should accept an array or a scalar
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	585 // as the third argument.
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	586 if (args(2).numel () > 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	587 error ("bitshift: N must be a scalar integer");
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	588 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	589 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	590 nbits = args(2).xint_value ("bitshift: N must be an integer");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	591
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	592 if (nbits < 0)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	593 error ("bitshift: N must be positive");
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	594 }
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	595 }
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	596
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	597 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	598
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	599 octave_value m_arg = args(0);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	600 std::string cname = m_arg.class_name ();
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	601
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	602 if (cname == "double")
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	603 {
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	604 static const int bits_in_mantissa
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	605 = std::numeric_limits<double>::digits;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	606
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	607 nbits = (nbits < bits_in_mantissa ? nbits : bits_in_mantissa);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	608 int64_t mask = max_mantissa_value<double> ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	609 if (nbits < bits_in_mantissa)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	610 mask = mask >> (bits_in_mantissa - nbits);
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	611 else if (nbits < 1)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	612 mask = 0;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	613 int bits_in_type = sizeof (double)
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	614 * std::numeric_limits<unsigned char>::digits;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	615 NDArray m = m_arg.array_value ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	616 DO_BITSHIFT ();
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	617 }
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	618 else if (cname == "uint8")
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	619 DO_UBITSHIFT (uint8, nbits < 8 ? nbits : 8);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	620 else if (cname == "uint16")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	621 DO_UBITSHIFT (uint16, nbits < 16 ? nbits : 16);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	622 else if (cname == "uint32")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	623 DO_UBITSHIFT (uint32, nbits < 32 ? nbits : 32);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	624 else if (cname == "uint64")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	625 DO_UBITSHIFT (uint64, nbits < 64 ? nbits : 64);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	626 else if (cname == "int8")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	627 DO_SBITSHIFT (int8, nbits < 8 ? nbits : 8);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	628 else if (cname == "int16")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	629 DO_SBITSHIFT (int16, nbits < 16 ? nbits : 16);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	630 else if (cname == "int32")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	631 DO_SBITSHIFT (int32, nbits < 32 ? nbits : 32);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	632 else if (cname == "int64")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	633 DO_SBITSHIFT (int64, nbits < 64 ? nbits : 64);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	634 else if (cname == "single")
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	635 {
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	636 static const int bits_in_mantissa
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	637 = std::numeric_limits<float>::digits;
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	638 nbits = (nbits < bits_in_mantissa ? nbits : bits_in_mantissa);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	639 int64_t mask = max_mantissa_value<float> ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	640 if (nbits < bits_in_mantissa)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	641 mask = mask >> (bits_in_mantissa - nbits);
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	642 else if (nbits < 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	643 mask = 0;
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	644 int bits_in_type = sizeof (float)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	645 * std::numeric_limits<unsigned char>::digits;
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	646 FloatNDArray m = m_arg.float_array_value ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	647 DO_BITSHIFT (Float);
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	648 }
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	649 else
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	650 error ("bitshift: not defined for %s objects", cname.c_str ());
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	651
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	652 return retval;
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	653 }
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	654
19146 a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	655 /*
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	656 %!assert (bitshift (uint8 (16), 1), uint8 ( 32))
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	657 %!assert (bitshift (uint16 (16), 2), uint16 ( 64))
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	658 %!assert (bitshift (uint32 (16), 3), uint32 (128))
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	659 %!assert (bitshift (uint64 (16), 4), uint64 (256))
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	660 %!assert (bitshift (uint8 (255), 1), uint8 (254))
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	661
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	662 %!error <K must be a scalar or array of integers> bitshift (16, 1.5)
19146 a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	663 %!error bitshift (16, {1})
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	664 %!error <N must be a scalar integer> bitshift (10, [-2 -1 0 1 2], [1 1 1 1 1])
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	665 %!error <N must be positive> bitshift (10, [-2 -1 0 1 2], -1)
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	666 */
a84f0182f912 bitfcns.cc: add tests for bitwise operators (some of them failing). Carnë Draug <carandraug@octave.org> parents: 18678 diff changeset	667
17390 4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	668 DEFUN (flintmax, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	669 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	670 @deftypefn {} {} flintmax ()\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	671 @deftypefnx {} {} flintmax (\"double\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	672 @deftypefnx {} {} flintmax (\"single\")\n\
17390 4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	673 Return the largest integer that can be represented consecutively in a\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	674 floating point value.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	675 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	676 The default class is @qcode{\"double\"}, but @qcode{\"single\"} is a valid\n\
20425 6947b9c82d4b doc: Change docstrings to use 'IEEE 754' rather than 'IEEE-754'. Rik <rik@octave.org> parents: 20172 diff changeset	677 option. On IEEE 754 compatible systems, @code{flintmax} is @w{@math{2^{53}}}\n\
6947b9c82d4b doc: Change docstrings to use 'IEEE 754' rather than 'IEEE-754'. Rik <rik@octave.org> parents: 20172 diff changeset	678 for @qcode{\"double\"} and @w{@math{2^{24}}} for @qcode{\"single\"}.\n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	679 @seealso{intmax, realmax, realmin}\n\
17390 4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	680 @end deftypefn")
4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	681 {
4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	682 int nargin = args.length ();
4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	683
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	684 if (nargin > 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	685 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	686
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	687 std::string cname = "double";
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	688 if (nargin == 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	689 cname = args(0).xstring_value ("flintmax: argument must be a string");
17390 4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	690
4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	691 if (cname == "double")
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	692 return ovl (static_cast<double> (max_mantissa_value<double> () + 1));
17390 4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	693 else if (cname == "single")
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	694 return ovl (static_cast<float> (max_mantissa_value<float> () + 1));
17390 4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	695 else
4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	696 error ("flintmax: not defined for class '%s'", cname.c_str ());
4bcd301754ce Add Matlab-compatible flintmax function Mike Miller <mtmiller@ieee.org> parents: 17389 diff changeset	697 }
16939 06897f865f0b Add flintmax() as an alias for function bitmax(). Rik <rik@octave.org> parents: 15195 diff changeset	698
20870 020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	699 /*
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	700 %!assert (flintmax (), 2^53)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	701 %!assert (flintmax ("double"), 2^53)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	702 %!assert (flintmax ("single"), single (2^24))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	703
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	704 %!error flintmax (0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	705 %!error flintmax ("double", 0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	706 %!error flintmax ("int32")
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	707 %!error flintmax ("char")
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	708 */
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	709
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	710 DEFUN (intmax, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	711 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	712 @deftypefn {} {} intmax (@var{type})\n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	713 Return the largest integer that can be represented in an integer type.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	714 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	715 The variable @var{type} can be\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	716 \n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	717 @table @code\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	718 @item int8\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	719 signed 8-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	720 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	721 @item int16\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	722 signed 16-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	723 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	724 @item int32\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	725 signed 32-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	726 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	727 @item int64\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	728 signed 64-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	729 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	730 @item uint8\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	731 unsigned 8-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	732 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	733 @item uint16\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	734 unsigned 16-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	735 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	736 @item uint32\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	737 unsigned 32-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	738 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	739 @item uint64\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	740 unsigned 64-bit integer.\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	741 @end table\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	742 \n\
18155 20f2b3c48c4c intmax, intmin: Fix default integer type in docstrings Mike Miller <mtmiller@ieee.org> parents: 17861 diff changeset	743 The default for @var{type} is @code{int32}.\n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	744 @seealso{intmin, flintmax}\n\
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	745 @end deftypefn")
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	746 {
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	747 int nargin = args.length ();
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	748
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	749 if (nargin > 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	750 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	751
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	752 std::string cname = "int32";
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	753 if (nargin == 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	754 cname = args(0).xstring_value ("intmax: argument must be a string");
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	755
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	756 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	757
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	758 if (cname == "uint8")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	759 retval = octave_uint8 (std::numeric_limits<uint8_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	760 else if (cname == "uint16")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	761 retval = octave_uint16 (std::numeric_limits<uint16_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	762 else if (cname == "uint32")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	763 retval = octave_uint32 (std::numeric_limits<uint32_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	764 else if (cname == "uint64")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	765 retval = octave_uint64 (std::numeric_limits<uint64_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	766 else if (cname == "int8")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	767 retval = octave_int8 (std::numeric_limits<int8_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	768 else if (cname == "int16")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	769 retval = octave_int16 (std::numeric_limits<int16_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	770 else if (cname == "int32")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	771 retval = octave_int32 (std::numeric_limits<int32_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	772 else if (cname == "int64")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	773 retval = octave_int64 (std::numeric_limits<int64_t>::max ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	774 else
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	775 error ("intmax: not defined for '%s' objects", cname.c_str ());
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	776
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	777 return retval;
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	778 }
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	779
20870 020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	780 /*
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	781 %!assert (intmax (), int32 (2^31 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	782 %!assert (intmax ("int8"), int8 (2^7 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	783 %!assert (intmax ("uint8"), uint8 (2^8 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	784 %!assert (intmax ("int16"), int16 (2^15 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	785 %!assert (intmax ("uint16"), uint16 (2^16 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	786 %!assert (intmax ("int32"), int32 (2^31 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	787 %!assert (intmax ("uint32"), uint32 (2^32 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	788 %!assert (intmax ("int64"), int64 (2^63 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	789 %!assert (intmax ("uint64"), uint64 (2^64 - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	790
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	791 %!error intmax (0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	792 %!error intmax ("int32", 0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	793 %!error intmax ("double")
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	794 %!error intmax ("char")
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	795 */
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	796
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	797 DEFUN (intmin, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	798 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	799 @deftypefn {} {} intmin (@var{type})\n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	800 Return the smallest integer that can be represented in an integer type.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	801 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	802 The variable @var{type} can be\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	803 \n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	804 @table @code\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	805 @item int8\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	806 signed 8-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	807 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	808 @item int16\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	809 signed 16-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	810 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	811 @item int32\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	812 signed 32-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	813 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	814 @item int64\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	815 signed 64-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	816 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	817 @item uint8\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	818 unsigned 8-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	819 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	820 @item uint16\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	821 unsigned 16-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	822 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	823 @item uint32\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	824 unsigned 32-bit integer.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10830 diff changeset	825 \n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	826 @item uint64\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	827 unsigned 64-bit integer.\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	828 @end table\n\
b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4952 diff changeset	829 \n\
18155 20f2b3c48c4c intmax, intmin: Fix default integer type in docstrings Mike Miller <mtmiller@ieee.org> parents: 17861 diff changeset	830 The default for @var{type} is @code{int32}.\n\
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20425 diff changeset	831 @seealso{intmax, flintmax}\n\
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	832 @end deftypefn")
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	833 {
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	834 int nargin = args.length ();
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	835
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	836 if (nargin > 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	837 print_usage ();
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	838
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	839 std::string cname = "int32";
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	840 if (nargin == 1)
a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	841 cname = args(0).xstring_value ("intmin: argument must be a string");
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	842
20918 6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	843 octave_value retval;
6f0bd96f93c0 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20870 diff changeset	844
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	845 if (cname == "uint8")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	846 retval = octave_uint8 (std::numeric_limits<uint8_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	847 else if (cname == "uint16")
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14725 diff changeset	848 retval = octave_uint16 (std::numeric_limits<uint16_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	849 else if (cname == "uint32")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	850 retval = octave_uint32 (std::numeric_limits<uint32_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	851 else if (cname == "uint64")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	852 retval = octave_uint64 (std::numeric_limits<uint64_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	853 else if (cname == "int8")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	854 retval = octave_int8 (std::numeric_limits<int8_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	855 else if (cname == "int16")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	856 retval = octave_int16 (std::numeric_limits<int16_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	857 else if (cname == "int32")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	858 retval = octave_int32 (std::numeric_limits<int32_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	859 else if (cname == "int64")
5828 22e23bee74c8 [project @ 2006-05-23 06:05:14 by jwe] jwe parents: 5823 diff changeset	860 retval = octave_int64 (std::numeric_limits<int64_t>::min ());
4915 c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	861 else
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	862 error ("intmin: not defined for '%s' objects", cname.c_str ());
c638c144d4da [project @ 2004-07-23 19:01:22 by jwe] jwe parents: 4908 diff changeset	863
4908 66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	864 return retval;
66af4b9f451e [project @ 2004-06-29 19:20:00 by jwe] jwe parents: diff changeset	865 }
10811 e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	866
20870 020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	867 /*
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	868 %!assert (intmin (), int32 (-2^31))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	869 %!assert (intmin ("int8"), int8 (-2^7))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	870 %!assert (intmin ("uint8"), uint8 (-2^8))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	871 %!assert (intmin ("int16"), int16 (-2^15))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	872 %!assert (intmin ("uint16"), uint16 (-2^16))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	873 %!assert (intmin ("int32"), int32 (-2^31))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	874 %!assert (intmin ("uint32"), uint32 (-2^32))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	875 %!assert (intmin ("int64"), int64 (-2^63))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	876 %!assert (intmin ("uint64"), uint64 (-2^64))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	877
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	878 %!error intmin (0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	879 %!error intmin ("int32", 0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	880 %!error intmin ("double")
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	881 %!error intmin ("char")
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	882 */
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	883
10811 e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	884 DEFUN (sizemax, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	885 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20804 diff changeset	886 @deftypefn {} {} sizemax ()\n\
10895 4176c5c62138 Imrove documentation string for sizemax Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	887 Return the largest value allowed for the size of an array.\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19864 diff changeset	888 \n\
10811 e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	889 If Octave is compiled with 64-bit indexing, the result is of class int64,\n\
10895 4176c5c62138 Imrove documentation string for sizemax Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	890 otherwise it is of class int32. The maximum array size is slightly\n\
4176c5c62138 Imrove documentation string for sizemax Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	891 smaller than the maximum value allowable for the relevant class as reported\n\
4176c5c62138 Imrove documentation string for sizemax Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	892 by @code{intmax}.\n\
10811 e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	893 @seealso{intmax}\n\
e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	894 @end deftypefn")
e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	895 {
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	896 if (args.length () != 0)
10811 e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	897 print_usage ();
e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	898
20804 a6eaedd8bd75 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20791 diff changeset	899 return octave_value (octave_int<octave_idx_type> (dim_vector::dim_max ()));
10811 e38c071bbc41 allow user query the maximum array size Jaroslav Hajek <highegg@gmail.com> parents: 10315 diff changeset	900 }
20870 020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	901
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	902 /*
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	903 %!assert (sizemax () >= (intmax ("int32") - 1))
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	904
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	905 %!error sizemax (0)
020b71557b12 2015 Code Sprint: add BIST tests to bitfcns.cc Mike Miller <mtmiller@octave.org> parents: 20853 diff changeset	906 */

Mercurial > octave

annotate libinterp/corefcn/bitfcns.cc @ 20918:6f0bd96f93c0