Skip to content

Commit 665c417

Browse files
refactor(bitwise): Rename Variables
1 parent f79bf80 commit 665c417

File tree

7 files changed

+52
-76
lines changed

7 files changed

+52
-76
lines changed

source/buffer/and.ts

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,21 @@
22
* Applies a bitwise AND to the contents of two buffers. Returns a new buffer.
33
*
44
* @example
5-
* bitwise.buffer.and(buffer1, buffer2, false) => Buffer(buffer1 AND buffer2)
5+
* bitwise.buffer.and(a, b, false) => Buffer(a AND b)
66
*
7-
* @param {Buffer} buffer1 first buffer
8-
* @param {Buffer} buffer2 second buffer
7+
* @param {Buffer} a first buffer
8+
* @param {Buffer} b second buffer
99
* @param {Boolean} isLooping loop through first buffer
10-
* @return {Buffer} buffer1 AND buffer2
10+
* @return {Buffer} a AND b
1111
*/
12-
export default (
13-
buffer1: Buffer,
14-
buffer2: Buffer,
15-
isLooping: boolean = false
16-
): Buffer => {
17-
const length = isLooping ? buffer2.length : buffer1.length
12+
export default (a: Buffer, b: Buffer, isLooping: boolean = false): Buffer => {
13+
const length: number = isLooping ? b.length : a.length
1814

19-
const result = Buffer.alloc(length)
15+
const result: Buffer = Buffer.alloc(length)
2016

21-
for (let i = 0; i < length; i++) {
22-
const j = isLooping ? i % buffer1.length : i
23-
result[i] = buffer1[j] & buffer2[i]
17+
for (let i: number = 0; i < length; i++) {
18+
const j = isLooping ? i % a.length : i
19+
result[i] = a[j] & b[i]
2420
}
2521

2622
return result

source/buffer/nand.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,21 @@
22
* Applies a bitwise NAND to the contents of two buffers. Returns a new buffer.
33
*
44
* @example
5-
* bitwise.buffer.nand(buffer1, buffer2, false) => Buffer(buffer1 NAND buffer2)
5+
* bitwise.buffer.nand(a, b, false) => Buffer(a NAND b)
66
*
7-
* @param {Buffer} buffer1 first buffer
8-
* @param {Buffer} buffer2 second buffer
7+
* @param {Buffer} a first buffer
8+
* @param {Buffer} b second buffer
99
* @param {Boolean} isLooping loop through first buffer
10-
* @return {Buffer} buffer1 NAND buffer2
10+
* @return {Buffer} a NAND b
1111
*/
12-
export default (
13-
buffer1: Buffer,
14-
buffer2: Buffer,
15-
isLooping: boolean = false
16-
): Buffer => {
17-
const length: number = isLooping ? buffer2.length : buffer1.length
12+
export default (a: Buffer, b: Buffer, isLooping: boolean = false): Buffer => {
13+
const length: number = isLooping ? b.length : a.length
1814

1915
const result: Buffer = Buffer.alloc(length)
2016

2117
for (let i: number = 0; i < length; i++) {
22-
const j: number = isLooping ? i % buffer1.length : i
23-
result[i] = ~(buffer1[j] & buffer2[i])
18+
const j: number = isLooping ? i % a.length : i
19+
result[i] = ~(a[j] & b[i])
2420
}
2521

2622
return result

source/buffer/nor.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,21 @@
22
* Applies a bitwise NOR to the contents of two buffers. Returns a new buffer.
33
*
44
* @example
5-
* bitwise.buffer.nor(buffer1, buffer2, false) => Buffer(buffer1 NOR buffer2)
5+
* bitwise.buffer.nor(a, b, false) => Buffer(a NOR b)
66
*
7-
* @param {Buffer} buffer1 first buffer
8-
* @param {Buffer} buffer2 second buffer
7+
* @param {Buffer} a first buffer
8+
* @param {Buffer} b second buffer
99
* @param {Boolean} isLooping loop through first buffer
10-
* @return {Buffer} buffer1 NOR buffer2
10+
* @return {Buffer} a NOR b
1111
*/
12-
export default (
13-
buffer1: Buffer,
14-
buffer2: Buffer,
15-
isLooping: boolean = false
16-
): Buffer => {
17-
const length: number = isLooping ? buffer2.length : buffer1.length
12+
export default (a: Buffer, b: Buffer, isLooping: boolean = false): Buffer => {
13+
const length: number = isLooping ? b.length : a.length
1814

1915
const result: Buffer = Buffer.alloc(length)
2016

2117
for (let i: number = 0; i < length; i++) {
22-
const j: number = isLooping ? i % buffer1.length : i
23-
result[i] = ~(buffer1[j] | buffer2[i])
18+
const j: number = isLooping ? i % a.length : i
19+
result[i] = ~(a[j] | b[i])
2420
}
2521

2622
return result

source/buffer/or.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,21 @@
22
* Applies a bitwise OR to the contents of two buffers. Returns a new buffer.
33
*
44
* @example
5-
* bitwise.buffer.or(buffer1, buffer2, false) => Buffer(buffer1 OR buffer2)
5+
* bitwise.buffer.or(a, b, false) => Buffer(a OR b)
66
*
7-
* @param {Buffer} buffer1 first buffer
8-
* @param {Buffer} buffer2 second buffer
7+
* @param {Buffer} a first buffer
8+
* @param {Buffer} b second buffer
99
* @param {Boolean} isLooping loop through first buffer
10-
* @return {Buffer} buffer1 OR buffer2
10+
* @return {Buffer} a OR b
1111
*/
12-
export default (
13-
buffer1: Buffer,
14-
buffer2: Buffer,
15-
isLooping: boolean = false
16-
): Buffer => {
17-
const length: number = isLooping ? buffer2.length : buffer1.length
12+
export default (a: Buffer, b: Buffer, isLooping: boolean = false): Buffer => {
13+
const length: number = isLooping ? b.length : a.length
1814

1915
const result: Buffer = Buffer.alloc(length)
2016

2117
for (let i: number = 0; i < length; i++) {
22-
const j: number = isLooping ? i % buffer1.length : i
23-
result[i] = buffer1[j] | buffer2[i]
18+
const j: number = isLooping ? i % a.length : i
19+
result[i] = a[j] | b[i]
2420
}
2521

2622
return result

source/buffer/xnor.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,21 @@
22
* Applies a bitwise XNOR to the contents of two buffers. Returns a new buffer.
33
*
44
* @example
5-
* bitwise.buffer.xnor(buffer1, buffer2, false) => Buffer(buffer1 XNOR buffer2)
5+
* bitwise.buffer.xnor(a, b, false) => Buffer(a XNOR b)
66
*
7-
* @param {Buffer} buffer1 first buffer
8-
* @param {Buffer} buffer2 second buffer
7+
* @param {Buffer} a first buffer
8+
* @param {Buffer} b second buffer
99
* @param {Boolean} isLooping loop through first buffer
10-
* @return {Buffer} buffer1 XNOR buffer2
10+
* @return {Buffer} a XNOR b
1111
*/
12-
export default (
13-
buffer1: Buffer,
14-
buffer2: Buffer,
15-
isLooping: boolean = false
16-
): Buffer => {
17-
const length: number = isLooping ? buffer2.length : buffer1.length
12+
export default (a: Buffer, b: Buffer, isLooping: boolean = false): Buffer => {
13+
const length: number = isLooping ? b.length : a.length
1814

1915
const result: Buffer = Buffer.alloc(length)
2016

2117
for (let i: number = 0; i < length; i++) {
22-
const j: number = isLooping ? i % buffer1.length : i
23-
result[i] = ~(buffer1[j] ^ buffer2[i])
18+
const j: number = isLooping ? i % a.length : i
19+
result[i] = ~(a[j] ^ b[i])
2420
}
2521

2622
return result

source/buffer/xor.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,21 @@
22
* Applies a bitwise XOR to the contents of two buffers. Returns a new buffer.
33
*
44
* @example
5-
* bitwise.buffer.xor(buffer1, buffer2, false) => Buffer(buffer1 XOR buffer2)
5+
* bitwise.buffer.xor(a, b, false) => Buffer(a XOR b)
66
*
7-
* @param {Buffer} buffer1 first buffer
8-
* @param {Buffer} buffer2 second buffer
7+
* @param {Buffer} a first buffer
8+
* @param {Buffer} b second buffer
99
* @param {Boolean} isLooping loop through first buffer
10-
* @return {Buffer} buffer1 XOR buffer2
10+
* @return {Buffer} a XOR b
1111
*/
12-
export default (
13-
buffer1: Buffer,
14-
buffer2: Buffer,
15-
isLooping: boolean = false
16-
): Buffer => {
17-
const length: number = isLooping ? buffer2.length : buffer1.length
12+
export default (a: Buffer, b: Buffer, isLooping: boolean = false): Buffer => {
13+
const length: number = isLooping ? b.length : a.length
1814

1915
const result: Buffer = Buffer.alloc(length)
2016

2117
for (let i: number = 0; i < length; i++) {
22-
const j: number = isLooping ? i % buffer1.length : i
23-
result[i] = buffer1[j] ^ buffer2[i]
18+
const j: number = isLooping ? i % a.length : i
19+
result[i] = a[j] ^ b[i]
2420
}
2521

2622
return result

source/byte/write.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import { Byte, UInt8 } from '../types'
66
* @example
77
* byte.write([0,0,1,0,1,0,1,0]) => 42
88
*
9-
* @param {Array} bits 8-bit unsigned integer
10-
* @return {Number}
9+
* @param {Array} byte 8 bits
10+
* @return {Number} 8-bit unsigned integer
1111
*/
1212
export default (byte: Byte): UInt8 => {
1313
if (!Array.isArray(byte) || byte.length !== 8)

0 commit comments

Comments
 (0)