Difference between revisions of "Bit (API)"

From ComputerCraft Wiki
Jump to: navigation, search
m (Moved summary out (test).)
(Pull out removed functions and add missing function)
Line 5: Line 5:
  
 
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
 
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tobits]]([[int (type)|int]] n)</td>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values.</td></tr>
 
  
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blshift]]([[int (type)|int]] n, [[int (type)|int]] bits)</td>
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blshift]]([[int (type)|int]] n, [[int (type)|int]] bits)</td>
Line 13: Line 10:
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.brshift]]([[int (type)|int]] n, [[int (type)|int]] bits)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.brshift]]([[int (type)|int]] n, [[int (type)|int]] bits)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right by a specified number of bits.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right arithmetically by a specified number of bits.</td></tr>
 +
 
 +
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blogic_rshift]]([[int (type)|int]] n, [[int (type)|int]] bits)</td>
 +
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right logically by a specified number of bits.</td></tr>
  
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bxor]]([[int (type)|int]] m, [[int (type)|int]] n)</td>
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bxor]]([[int (type)|int]] m, [[int (type)|int]] n)</td>
Line 26: Line 26:
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bnot]]([[int (type)|int]] n)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bnot]]([[int (type)|int]] n)</td>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise NOT of a number.</td></tr>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise NOT of a number.</td></tr>
 +
</table>
 +
 +
The following functions used to exist in this API but no longer do:
 +
 +
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
 +
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">[[File:Grid_disk.png|24px]]&nbsp;&nbsp;Bit (API)</td></tr>
 +
 +
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
 +
 +
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tobits]]([[int (type)|int]] n)</td>
 +
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values.</td></tr>
  
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tonumb]]([[table (type)|table]] bit_tbl)</td>
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tonumb]]([[table (type)|table]] bit_tbl)</td>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Converts an array (numerically-indexed table) of 0 and 1 values representing a number in binary into that number.</td></tr>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Converts an array (numerically-indexed table) of 0 and 1 values representing a number in binary into that number.</td></tr>
 
</table>
 
</table>
 
  
 
[[Category:APIs]]
 
[[Category:APIs]]

Revision as of 18:03, 21 April 2013

The Bit API is for manipulating numbers using bitwise binary operations.

Grid disk.png  Bit (API)
Method nameDescription
bit.blshift(int n, int bits) Shifts a number left by a specified number of bits.
bit.brshift(int n, int bits) Shifts a number right arithmetically by a specified number of bits.
bit.blogic_rshift(int n, int bits) Shifts a number right logically by a specified number of bits.
bit.bxor(int m, int n) Computes the bitwise exclusive OR of two numbers.
bit.bor(int m, int n) Computes the bitwise inclusive OR of two numbers.
bit.band(int m, int n) Computes the bitwise AND of two numbers.
bit.bnot(int n) Computes the bitwise NOT of a number.

The following functions used to exist in this API but no longer do:

Grid disk.png  Bit (API)
Method nameDescription
bit.tobits(int n) Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values.
bit.tonumb(table bit_tbl) Converts an array (numerically-indexed table) of 0 and 1 values representing a number in binary into that number.