source: trunk/SRC/ToBeReviewed/LECTURE/binary.pro @ 97

Last change on this file since 97 was 97, checked in by pinsard, 18 years ago

start to modify headers of Obsolete *.pro files for better idldoc output

  • Property svn:executable set to *
File size: 3.7 KB
Line 
1;+
2; Name:
3;   binary
4; Purpose:
5;   Returns the binary representation of a number of any numerical type.
6; Argument:
7;   number   scalar or array of numbers (any numerical type)
8; Returns:
9;   Byte array with binary representation of numbers.
10; Examples:
11;   Binary representation of 11b:
12;     IDL> print, binary(11b)
13;     0 0 0 0 1 0 1 1
14;   Binary representation of pi (x86: Little-endian IEEE representation):
15;     IDL> print, format='(z9.8,5x,4(1x,8i1))', long(!pi,0), binary(!pi)
16;      40490fdb      01000000 01001001 00001111 11011011 (x86 Linux)
17;      0fdb4149      00001111 11011011 01000001 01001001 (Alpha OpenVMS)
18;     IDL> print, format='(8(1x,8i0))', binary(!dpi)
19;      01000000 00001001 00100001 11111011 01010100 01000100 00101101 00011000
20;   Some first tests before type double was added:
21;     print, format='(2a6,4x,2z9.8,4x,8z3.2)', $
22;       !version.arch, !version.os, long(!dpi,0,2), byte(!dpi,0,8)
23;       x86 linux     54442d18 400921fb     18 2d 44 54 fb 21 09 40
24;     sparc sunos     400921fb 54442d18     40 09 21 fb 54 44 2d 18
25;     alpha   vms     0fda4149 68c0a221     49 41 da 0f 21 a2 c0 68
26;     (Beginning with IDL 5.1, Alpha VMS uses IEEE representation as well.)
27; Modification history:
28;    19 Dec 1997  Originally a news posting by David Fanning.
29;                       (Re: bits from bytes)
30;    20 Dec 1997  "Complete" rewrite: eliminate loops.
31;    22 Dec 1997  Bit shift instead of exponentiation, return byte
32;      array, handle input arrays.
33;      Think about double and complex types.
34;    22 Sep 1998  Complete rewrite: reduce every numerical type to
35;      single bytes. Check that big and little endian machines
36;      return exactly the same results (if IEEE).
37;    7 May 2003     Added newish data types, unsigned and long64.  BT
38;-
39function binary, number
40  s = size(number)
41  type = s[s[0] + 1]
42  n_no = s[s[0] + 2]
43; Numerical types: (will have to be completed if IDL adds double-long, ...)
44; 1: byte             (1-byte unsigned integer)
45; 2: integer          (2-byte   signed integer)
46; 3: long             (4-byte   signed integer)
47; 4: floating-point   (4-byte, single precision)
48; 5: double-precision (8-byte, double precision)
49; 6: complex        (2x4-byte, single precision)
50; 9: double-complex (2x8-byte, double precision)
51; 12: uInt      (2-byte, unsigned integer)
52; 13: uLong     (4-byte, unsigned integer)
53; 14: Long64       (8-byte, signed integer)
54; 15: uLong64      (8-byte, unsigned integer)
55; Non-numerical types:
56; 0: undefined, 7: string, 8: structure, 10: pointer, 11: object reference
57;  nbyt = [0, 1, 2, 4, 4, 8, 8, 0, 0, 16, 0, 0] ; number of bytes per type
58; code = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
59  nbyt = [0, 1, 2, 4, 4, 8, 8, 0, 0, 16, 0, 0,  2,  4,  8,  8]
60  ntyp = nbyt[type]
61  if ntyp eq 0 then message, 'Invalid argument (must be numerical type).'
62  bits = [128, 64, 32, 16,  8,  4,  2,  1] ; = ishft(1b, 7-indgen(8))
63; For correct array handling and byte comparison, 'number' and 'bits' require
64; same dimensions -> numvalue and bitvalue
65  bitvalue = ((bits)[*, intarr(ntyp)])[*, *, intarr(n_no)]
66  little_endian = (byte(1, 0, 1))[0]
67; In case of complex type and little endian machine, swap the two float values
68; before the complete second dimension is reversed at returning.
69  if (type eq 6 or type eq 9) and little_endian then $ ; type complex
70    numvalue = reform((byte([number], 0, 1, ntyp/2, 2, n_no))$
71                      [intarr(8), *, [1,0], *], 8, ntyp, n_no) $
72  else numvalue = (byte([number], 0, 1, ntyp, n_no))[intarr(8), *, *]
73; On little endian machines, the second dimension of the return value must
74; be reversed.
75  if little_endian AND type NE 1 then $
76    return, reverse((numvalue and bitvalue) ne 0, 2) else $
77    return,         (numvalue and bitvalue) ne 0
78end
Note: See TracBrowser for help on using the repository browser.