home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / JSAGE / ZSUS / PROGPACK / BITMATH.LBR / BITMATH.HZP / BITMATH.HLP
Text File  |  1989-10-31  |  4KB  |  144 lines
  1. BITMATH Introduction
  2. Set, Reset, or Test a bit in the byte at HL.........SET_M, RES_M, TST_M
  3. Logical AND, OR, XOR with (HL), result in (HL)....ANDM2M, ORM2M, XORM2M
  4. Reverse the bit order in the byte at HL..........................MIRROR
  5. Set bit n in A, reset others......................................EXP_A
  6. Return LOG(A) in A, ignoring all but highest bit.................LOG2_A
  7. Set up to 8 least significant bits in A, others reset.............MASK8
  8. Set up to 16 least significant bits in BC, others reset..........MASK16
  9. : 
  10. BITMATH Introduction
  11.  
  12. This a collection of routines to manipulate the bits in a byte at HL,
  13. and routines to perform certain binary pseudo-exponential operations
  14. to create bit patterns for logical masking. Examples are:
  15.  
  16.     Input        Output        Function/Routine
  17.     05h        00100000b        EXP_A
  18.     001xxxxx    05h            LOG2_A
  19.     05h        00111111b        MASK8
  20.     0Bh        00001111 11111111    MASK16
  21.     01011101    10111010        MIRROR
  22.  
  23. The MASKn functions are really [EXP(A+1) - 1], a function encountered
  24. in Directory and DPB calculations. (EXP(n) = "raise 2 to power n")
  25.  
  26. LOG2_A is the inverse operation to MASK8, not a true binary LOG.
  27. It ignores all but the highest order bit in (input).
  28.  
  29. The MIRROR function is used to convert bytes between low-bit-first
  30. and high-bit-first for display convenience.
  31. : 
  32. Set, Reset, or Test a bit in the byte at HL
  33.  
  34.      Routines:            SET_M, RES_M, TST_M
  35.  
  36.      Function:            Set, Reset, or Test a bit 
  37.                 in the byte at HL
  38.  
  39.      Inputs:            A  = bit number (0-7)
  40.                 HL = address of the byte
  41.  
  42.      Outputs:            The bit is set, reset, or tested
  43.  
  44.      Registers Affected:      AF,BC
  45.  
  46.     FLAGS:  if Z, c = a = 0, else NZ, c = a = 0ffh
  47. NOTE: the z/nz returns are significant only for TST_M
  48. : 
  49. Logical AND, OR, XOR with (HL), result in (HL)
  50.  
  51.      Routine:            ANDM2M, ORM2M, XORM2M
  52.  
  53.      Function:            as above, and implied in names
  54.  
  55.      Inputs:            A = byte to combine with (HL)
  56.                 HL = address of memory operand
  57.  
  58.      Outputs:            byte in memory is modified
  59.  
  60.      Registers Affected:    AF
  61.  
  62. : 
  63. Reverse the bit order in the byte at HL. (mirror image)
  64.  
  65.  
  66.      Routine:            MIRROR
  67.  
  68.      Function:            Invert the order of the bits at (hl)
  69.                 by swapping bits 0-7,1-6,2-5,3-4
  70.  
  71.      Inputs:            HL = addr of byte to invert
  72.  
  73.      Outputs:            mirror image in (HL)
  74.  
  75.      Registers Affected:    AF
  76.                 all other registers preserved
  77.  
  78. : 
  79. Set bit n in A, reset others.
  80.  
  81.      Routine:            EXP_A
  82.  
  83.      Function:            Set a single bit in reg A,
  84.                 reset all others.
  85.  
  86.      Inputs:            A = bit position to set (0-7)
  87.  
  88.      Outputs:            A = requested bit set, others 0
  89.  
  90.      Registers Affected:    all other registers preserved.
  91.                 flags are undefined
  92.  
  93. : 
  94. Return LOG(A) in A, ignoring all but highest bit.
  95.  
  96.      Routine:            LOG2_A:
  97.  
  98.      Function:            Convert a byte to the ordinal number
  99.                 in binary corresponding to the bit 
  100.                 position of the highest bit set in 
  101.                 the byte. This is a special case of
  102.                 log n, where n= 0...7
  103.  
  104.      Inputs:            A = the byte to convert
  105.  
  106.      Outputs:            A contains the log of A (bit position)
  107.  
  108.      Registers Affected:    AF
  109.                 Other registers preserved
  110. : 
  111. Set up to 8 least significant bits in A, others reset.
  112.  
  113.      Routine:            MASK8
  114.  
  115.      Function:            Set n least significant bits in reg A.
  116.                 Remaining bits are reset.
  117.                 n is specified as a number, (0-7) which
  118.                 defines the highest bit set.
  119.  
  120.      Inputs:            A = highest bit to set (0-7)
  121.  
  122.      Outputs:            A = filled with 1's from position
  123.                 0 up through position specified
  124.  
  125.      Registers Affected:    AF
  126.  
  127. : 
  128. Set up to 16 least significant bits in BC, others reset.
  129.  
  130.      Routine:            MASK16
  131.  
  132.      Function:            Set the n least significant bits in
  133.                 register pair BC according to the
  134.                 value n(0..15) in A.
  135.  
  136.      Inputs:            A = highest bit set position
  137.  
  138.      Outputs:            BC contains the mask
  139.  
  140.      Registers Affected:    BC is used
  141.                 A is not preserved
  142.  
  143.      Other Routines Called:    MASK8
  144.