summaryrefslogtreecommitdiffhomepage
path: root/libs/nixio/docsrc/nixio.bit.lua
blob: 3bdad51f2f53c4f886e24e37533bf745cbfe2218 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
--- Bitfield operators and mainpulation functions.
-- Can be used as a drop-in replacement for bitlib.
module "nixio.bit"

--- Bitwise OR several numbers.
-- @class function
-- @name bor
-- @param oper1	First Operand
-- @param oper2 Second Operand
-- @param ...	More Operands
-- @return number

--- Bitwise AND several numbers.
-- @class function
-- @name band
-- @param oper1	First Operand
-- @param oper2 Second Operand
-- @param ...	More Operands
-- @return number

--- Bitwise XOR several numbers.
-- @class function
-- @name bxor
-- @param oper1	First Operand
-- @param oper2 Second Operand
-- @param ...	More Operands
-- @return number

--- Left shift a number.
-- @class function
-- @name shl
-- @param oper	number
-- @param shift	bits to shift 
-- @return number

--- Right shift a number.
-- @class function
-- @name shr
-- @param oper	number
-- @param shift	bits to shift 
-- @return number

--- Arithmetically right shift a number.
-- @class function
-- @name ashr
-- @param oper	number
-- @param shift	bits to shift 
-- @return number

--- Integer division of 2 or more numbers.
-- @class function
-- @name div
-- @param oper1	Operand 1
-- @param oper2 Operand 2
-- @param ... More Operands
-- @return number

--- Cast a number to the bit-operating range.
-- @class function
-- @name cast
-- @param oper	number
-- @return number

--- Sets one or more flags of a bitfield.
-- @class function
-- @name set
-- @param bitfield	Bitfield
-- @param flag1 First Flag
-- @param ...	More Flags
-- @return altered bitfield

--- Unsets one or more flags of a bitfield.
-- @class function
-- @name unset
-- @param bitfield	Bitfield
-- @param flag1 First Flag
-- @param ...	More Flags
-- @return altered bitfield

--- Checks whether given flags are set in a bitfield.
-- @class function
-- @name check
-- @param bitfield	Bitfield
-- @param flag1 First Flag
-- @param ...	More Flags
-- @return true when all flags are set, otherwise false