octave: scripts/general/xor.m annotate

annotate scripts/general/xor.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 1995-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 ##
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	6 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	7 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24490 diff changeset	9 ## Octave is free software: you can redistribute it and/or modify it
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	10 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24490 diff changeset	11 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	13 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3426 diff changeset	14 ## Octave is distributed in the hope that it will be useful, but
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	18 ##
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	19 ## 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: 6157 diff changeset	20 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24490 diff changeset	21 ## <https://www.gnu.org/licenses/>.
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	22
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2870 diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## @deftypefn {} {@var{z} =} xor (@var{x}, @var{y})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 19833 diff changeset	25 ## @deftypefnx {} {@var{z} =} xor (@var{x1}, @var{x2}, @dots{})
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	26 ## Return the @dfn{exclusive or} of @var{x} and @var{y}.
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	27 ##
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2870 diff changeset	28 ## For boolean expressions @var{x} and @var{y},
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	29 ## @code{xor (@var{x}, @var{y})} is true if and only if one of @var{x} or
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	30 ## @var{y} is true. Otherwise, if @var{x} and @var{y} are both true or both
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	31 ## false, @code{xor} returns false.
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	32 ##
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	33 ## The truth table for the xor operation is
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	34 ##
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	35 ## @multitable @columnfractions 0.44 .03 .05 .03 0.44
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	36 ## @item @tab @var{x} @tab @var{y} @tab @var{z} @tab
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	37 ## @item @tab - @tab - @tab - @tab
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	38 ## @item @tab 0 @tab 0 @tab 0 @tab
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	39 ## @item @tab 1 @tab 0 @tab 1 @tab
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	40 ## @item @tab 0 @tab 1 @tab 1 @tab
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	41 ## @item @tab 1 @tab 1 @tab 0 @tab
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	42 ## @end multitable
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	43 ##
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	44 ## If more than two arguments are given the xor operation is applied
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	45 ## cumulatively from left to right:
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	46 ##
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	47 ## @example
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	48 ## (@dots{}((x1 XOR x2) XOR x3) XOR @dots{})
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	49 ## @end example
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	50 ##
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51 ## @seealso{and, or, not}
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2870 diff changeset	52 ## @end deftypefn
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	53
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	54 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	55 ## Created: 16 September 1994
6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	56 ## Adapted-By: jwe
6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	57
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	58 function z = xor (x, y, varargin)
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	59
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	60 if (nargin < 2)
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	61 print_usage ();
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	62 endif
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	63
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	64 z = __xor__ (x, y);
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	65
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	66 ## Slow expansion to multiple arguments.
23090 8cb4a2c07bce doc: Fix '##' in middle of docstring/comment lines (bug #50145).50145).50145).50145).50145). Rik <rik@octave.org> parents: 23083 diff changeset	67 ## Probably okay number of elements will be small.
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	68 if (! isempty (varargin))
19597 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19193 diff changeset	69 for i = 1:numel (varargin)
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	70 z = __xor__ (z, varargin{i});
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	71 endfor
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	72 endif
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	73
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	74 endfunction
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	75
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	76 function z = __xor__ (x, y)
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	77
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	78 if (isscalar (x) \|\| isscalar (y) \|\| size_equal (x, y))
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	79 ## Typecast to logicals is necessary for other numeric types.
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	80 z = logical (x) != logical (y);
2621 337a09dd1c06 [project @ 1997-01-24 21:49:41 by jwe] jwe parents: 2538 diff changeset	81 else
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	82 try
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	83 z = bsxfun (@xor, x, y);
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	84 catch
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	85 error ("xor: X and Y must be of compatible size or scalars");
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	86 end_try_catch
2538 6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	87 endif
6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	88
6f71af650490 [project @ 1996-11-19 21:41:48 by jwe] jwe parents: diff changeset	89 endfunction
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	90
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	91
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	92 %!assert (xor ([1, 1, 0, 0], [0, 1, 0, 1]), logical ([1, 0, 0, 1]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	93 %!assert (xor ([i, i, 0, 0], [1, 0, 1, 0]), logical ([0, 1, 1, 0]))
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	94
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95 %!assert (xor (eye (2), fliplr (eye (2))), logical (ones (2)))
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	96 %!assert (xor (speye (2), fliplr (speye (2))), sparse (logical (ones (2))))
7385 8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe] jwe parents: 7017 diff changeset	97
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	98 ## Test XOR reduction
19193 8661727db27a xor.m: Fix failing BIST test. Rik <rik@octave.org> parents: 19188 diff changeset	99 %!assert (xor ([1 0], [1 1], [0 0]), logical ([0 1]))
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	100
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	101 ## Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	102 %!error xor ()
19188 c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	103 %!error xor (1)
c3611856cdd4 xor.m: Extend to handle more than 2 arguments as a reduction operator. Rik <rik@octave.org> parents: 17744 diff changeset	104 %!error <X and Y must be of compatible size> xor (ones (3,2), ones (2,3))

Mercurial > octave

annotate scripts/general/xor.m @ 27919:1891570abac8