Mercurial > octave
annotate scripts/miscellaneous/swapbytes.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) 2007-2020 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26600
diff
changeset
|
2 ## |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26600
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:
26600
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:
26600
diff
changeset
|
5 ## |
6869 | 6 ## |
7 ## This file is part of Octave. | |
8 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
9 ## Octave is free software: you can redistribute it and/or modify it |
6869 | 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:
23220
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. |
6869 | 13 ## |
14 ## Octave is distributed in the hope that it will be useful, but | |
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. |
6869 | 18 ## |
19 ## You should have received a copy of the GNU General Public License | |
7016 | 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:
23220
diff
changeset
|
21 ## <https://www.gnu.org/licenses/>. |
6869 | 22 |
23 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20164
diff
changeset
|
24 ## @deftypefn {} {} swapbytes (@var{x}) |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
25 ## Swap the byte order on values, converting from little endian to big endian |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
26 ## and vice versa. |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
27 ## |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
28 ## For example: |
6869 | 29 ## |
30 ## @example | |
31 ## @group | |
32 ## swapbytes (uint16 (1:4)) | |
26600
f6730533820e
doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents:
26376
diff
changeset
|
33 ## @result{} 256 512 768 1024 |
6869 | 34 ## @end group |
35 ## @end example | |
36 ## | |
37 ## @seealso{typecast, cast} | |
38 ## @end deftypefn | |
39 | |
40 function y = swapbytes (x) | |
12847
619c1895e3e0
codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
41 |
6869 | 42 if (nargin != 1) |
43 print_usage (); | |
44 endif | |
45 | |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
46 cls = class (x); |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
47 if (strcmp (cls, "int8") || strcmp (cls, "uint8") || isempty (x)) |
6869 | 48 y = x; |
49 else | |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
50 if (strcmp (cls, "int16") || strcmp (cls, "uint16")) |
6869 | 51 nb = 2; |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
52 elseif (strcmp (cls, "single") |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
53 || strcmp (cls, "int32") || strcmp (cls, "uint32")) |
6869 | 54 nb = 4; |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
55 elseif (strcmp (cls, "double") |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
56 || strcmp (cls, "int64") || strcmp (cls, "uint64")) |
6869 | 57 nb = 8; |
58 else | |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
59 error ("swapbytes: invalid object of class '%s'", cls); |
6869 | 60 endif |
61 y = reshape (typecast (reshape (typecast (x(:), "uint8"), nb, numel (x)) | |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
62 ([nb : -1 : 1], :) (:), cls), size (x)); |
6869 | 63 endif |
12847
619c1895e3e0
codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
64 |
6869 | 65 endfunction |
12847
619c1895e3e0
codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
66 |
619c1895e3e0
codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
67 |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
68 %!assert (swapbytes (uint16 (1:4)), uint16 ([256 512 768 1024])) |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
69 %!test |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
70 %! assert (swapbytes (swapbytes (pi)), pi); |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
71 %! assert (swapbytes (swapbytes (single (pi))), single (pi)); |
12847
619c1895e3e0
codesprint: Add tests for swapbytes.m
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
72 |
19209
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
73 ## Test input validation |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
74 %!error swapbytes () |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
75 %!error swapbytes (1, 2) |
827ac8b5ae07
swapbytes.m: Add support for 'single' type.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
76 %!error <invalid object of class 'cell'> swapbytes ({1}) |