sheets/functions/bitops.xml

0001 <!DOCTYPE KSpreadFunctions>
0002 <KSpreadFunctions>
0003
0004 <Group>
0005     <GroupName>Bit Operations</GroupName>
0006
0007     <Function>
0008         <Name>BITAND</Name>
0009         <Type>Int</Type>
0010         <Parameter>
0011             <Comment>First number</Comment>
0012             <Type>Int</Type>
0013         </Parameter>
0014         <Parameter>
0015             <Comment>Second number</Comment>
0016             <Type>Int</Type>
0017         </Parameter>
0018         <Help>
0019             <Text>The BITAND() function performs a bit-wise AND operation for the two integer parameters.</Text>
0020             <Syntax>BITAND(value; value)</Syntax>
0021             <Example>BITAND(12;10) returns 8 (because decimal 12 is binary 1100, and decimal 10 is binary 1010; and 1100 "anded" with 1010 is 1000, which is integer 8).</Example>
0022             <Related>BITOR</Related>
0023             <Related>BITXOR</Related>
0024         </Help>
0025     </Function>
0026
0027     <Function>
0028         <Name>BITLSHIFT</Name>
0029         <Type>Int</Type>
0030         <Parameter>
0031             <Comment>First number</Comment>
0032             <Type>Int</Type>
0033         </Parameter>
0034         <Parameter>
0035             <Comment>Amount to left shift by</Comment>
0036             <Type>Int</Type>
0037         </Parameter>
0038         <Help>
0039             <Text>The BITLSHIFT() function performs a bit-wise left shift operation of the first parameter. The number of bits to shift by is specified by the second parameter. Note that a negative number of bits to left shift by becomes a right shift. </Text>
0040             <Syntax>BITLSHIFT(value; shift size)</Syntax>
0041             <Related>BITLSHIFT</Related>
0042         </Help>
0043     </Function>
0044
0045     <Function>
0046         <Name>BITRSHIFT</Name>
0047         <Type>Int</Type>
0048         <Parameter>
0049             <Comment>First number</Comment>
0050             <Type>Int</Type>
0051         </Parameter>
0052         <Parameter>
0053             <Comment>Amount to right shift by</Comment>
0054             <Type>Int</Type>
0055         </Parameter>
0056         <Help>
0057             <Text>The BITRSHIFT() function performs a bit-wise right shift operation of the first parameter. The number of bits to shift by is specified by the second parameter. Note that a negative number of bits to right shift by becomes a left shift. </Text>
0058             <Syntax>BITRSHIFT(value; shift size)</Syntax>
0059             <Related>BITLSHIFT</Related>
0060         </Help>
0061     </Function>
0062
0063     <Function>
0064         <Name>BITOR</Name>
0065         <Type>Int</Type>
0066         <Parameter>
0067             <Comment>First number</Comment>
0068             <Type>Int</Type>
0069         </Parameter>
0070         <Parameter>
0071             <Comment>Second number</Comment>
0072             <Type>Int</Type>
0073         </Parameter>
0074         <Help>
0075             <Text>The BITOR() function performs a bit-wise OR operation for the two integer parameters. </Text>
0076             <Syntax>BITOR(value; value)</Syntax>
0077             <Example>BITOR(12;10) returns 14 (because decimal 12 is binary 1100, and decimal 10 is binary 1010; and 1100 "ored" with 1010 is 1110, which is integer 14).</Example>
0078             <Related>BITAND</Related>
0079             <Related>BITXOR</Related>
0080         </Help>
0081     </Function>
0082
0083     <Function>
0084         <Name>BITXOR</Name>
0085         <Type>Int</Type>
0086         <Parameter>
0087             <Comment>First number</Comment>
0088             <Type>Int</Type>
0089         </Parameter>
0090         <Parameter>
0091             <Comment>Second number</Comment>
0092             <Type>Int</Type>
0093         </Parameter>
0094         <Help>
0095             <Text>The BITXOR() function performs a bit-wise exclusive-OR operation for the two integer parameters. </Text>
0096             <Syntax>BITXOR(value; value)</Syntax>
0097             <Example>BITXOR(12;10) returns 6 (because decimal 12 is binary 1100, and decimal 10 is binary 1010; and 1100 "xored" with 1010 is 0110, which is integer 6).</Example>
0098             <Related>BITAND</Related>
0099             <Related>BITOR</Related>
0100         </Help>
0101     </Function>
0102
0103 </Group>
0104
0105 </KSpreadFunctions>