mathjs/test/unit-tests/function/bitwise/bitAnd.test.js

// test bitAnd
import assert from 'assert'

import math from '../../../../src/defaultInstance.js'
const bignumber = math.bignumber
const bitAnd = math.bitAnd

describe('bitAnd', function () {
  it('should bitwise and two numbers', function () {
    assert.strictEqual(bitAnd(53, 131), 1)
    assert.strictEqual(bitAnd(2, 3), 2)
    assert.strictEqual(bitAnd(-2, 3), 2)
    assert.strictEqual(bitAnd(2, -3), 0)
    assert.strictEqual(bitAnd(-5, -3), -7)
  })

  it('should bitwise and booleans', function () {
    assert.strictEqual(bitAnd(true, true), 1)
    assert.strictEqual(bitAnd(true, false), 0)
    assert.strictEqual(bitAnd(false, true), 0)
    assert.strictEqual(bitAnd(false, false), 0)
  })

  it('should bitwise and mixed numbers and booleans', function () {
    assert.strictEqual(bitAnd(1, true), 1)
    assert.strictEqual(bitAnd(1, false), 0)
    assert.strictEqual(bitAnd(true, 1), 1)
    assert.strictEqual(bitAnd(false, 1), 0)
  })

  it('should bitwise and bignumbers', function () {
    assert.deepStrictEqual(bitAnd(bignumber(1), bignumber(2)), bignumber(0))
    assert.deepStrictEqual(bitAnd(bignumber('-1.0e+31'), bignumber('-1.0e+32')), bignumber('-101273397985285317082036849082368'))
    assert.deepStrictEqual(bitAnd(bignumber('1.0e+31'), bignumber('1.0e+32')), bignumber('8726602014714682917961003433984'))
    assert.deepStrictEqual(bitAnd(bignumber('-1.0e+31'), bignumber('1.0e+32')), bignumber('91273397985285317082038996566016'))
    assert.deepStrictEqual(bitAnd(bignumber('1.0e+31'), bignumber('-1.0e+32')), bignumber('1273397985285317082036849082368'))
    assert.deepStrictEqual(bitAnd(bignumber('2.1877409333271352879E+75'), bignumber('-3.220131224058161211554E+42')), bignumber('2187740933327135287899999999999996863578490213829130431270426161710498840576'))
  })

  it('should bitwise and mixed numbers and bignumbers', function () {
    assert.deepStrictEqual(bitAnd(bignumber(1), 2), bignumber(0))
    assert.deepStrictEqual(bitAnd(1, bignumber(2)), bignumber(0))
    assert.deepStrictEqual(bitAnd(bignumber(7), 9), bignumber(1))
    assert.deepStrictEqual(bitAnd(7, bignumber(9)), bignumber(1))
  })

  it('should bitwise and mixed booleans and bignumbers', function () {
    assert.deepStrictEqual(bitAnd(bignumber(1), true), bignumber(1))
    assert.deepStrictEqual(bitAnd(bignumber(1), false), bignumber(0))
    assert.deepStrictEqual(bitAnd(false, bignumber(3)), bignumber(0))
    assert.deepStrictEqual(bitAnd(true, bignumber(3)), bignumber(1))
  })

  it('should throw an error if used with a unit', function () {
    assert.throws(function () { bitAnd(math.unit('5cm'), 2) }, /TypeError: Unexpected type of argument/)
    assert.throws(function () { bitAnd(2, math.unit('5cm')) }, /TypeError: Unexpected type of argument/)
    assert.throws(function () { bitAnd(math.unit('2cm'), math.unit('5cm')) }, /TypeError: Unexpected type of argument/)
  })

  it('should throw an error if the parameters are not integers', function () {
    assert.throws(function () {
      bitAnd(1.1, 1)
    }, /Integers expected in function bitAnd/)
    assert.throws(function () {
      bitAnd(1, 1.1)
    }, /Integers expected in function bitAnd/)
    assert.throws(function () {
      bitAnd(1.1, 1.1)
    }, /Integers expected in function bitAnd/)
    assert.throws(function () {
      bitAnd(bignumber(1.1), 1)
    }, /Integers expected in function bitAnd/)
    assert.throws(function () {
      bitAnd(1, bignumber(1.1))
    }, /Integers expected in function bitAnd/)
    assert.throws(function () {
      bitAnd(bignumber(1.1), bignumber(1))
    }, /Integers expected in function bitAnd/)
    assert.throws(function () {
      bitAnd(bignumber(1), bignumber(1.1))
    }, /Integers expected in function bitAnd/)
  })

  it('should bitwise and arrays correctly', function () {
    const a = [[1, 4], [3, 2]]

    // array - array
    let b = [[5, 8], [7, 6]]
    let c = bitAnd(a, b)
    assert.deepStrictEqual(c, [[1, 0], [3, 2]])

    // array - dense
    b = math.matrix([[5, 8], [7, 6]])
    c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.matrix([[1, 0], [3, 2]]))

    // array - sparse
    b = math.sparse([[5, 8], [7, 6]])
    c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.sparse([[1, 0], [3, 2]]))
  })

  it('should bitwise and dense matrix correctly', function () {
    const a = math.matrix([[1, 4], [3, 2]])

    // dense - array
    let b = [[5, 8], [7, 6]]
    let c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.matrix([[1, 0], [3, 2]]))

    // dense - dense
    b = math.matrix([[5, 8], [7, 6]])
    c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.matrix([[1, 0], [3, 2]]))

    // dense - sparse
    b = math.sparse([[5, 8], [7, 6]])
    c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.sparse([[1, 0], [3, 2]]))
  })

  it('should bitwise and sparse matrix correctly', function () {
    const a = math.sparse([[1, 4], [3, 2]])

    // sparse - array
    let b = [[5, 8], [7, 6]]
    let c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.sparse([[1, 0], [3, 2]]))

    // sparse - dense
    b = math.matrix([[5, 8], [7, 6]])
    c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.sparse([[1, 0], [3, 2]]))

    // sparse - sparse
    b = math.sparse([[5, 8], [7, 6]])
    c = bitAnd(a, b)
    assert.deepStrictEqual(c, math.sparse([[1, 0], [3, 2]]))

    // sparse - sparse pattern
    b = new math.SparseMatrix({
      index: [0, 1],
      ptr: [0, 1, 2],
      size: [2, 2]
    })
    c = bitAnd(a, b)
    assert.deepStrictEqual(
      c,
      new math.SparseMatrix({
        index: [0, 1],
        ptr: [0, 1, 2],
        size: [2, 2]
      }))

    // sparse pattern - sparse
    c = bitAnd(b, a)
    assert.deepStrictEqual(
      c,
      new math.SparseMatrix({
        index: [0, 1],
        ptr: [0, 1, 2],
        size: [2, 2]
      }))
  })

  it('should bitwise and matrices correctly', function () {
    const a2 = math.matrix([[1, 2], [3, 4]])
    const a3 = math.matrix([[5, 6], [7, 8]])
    const a4 = bitAnd(a2, a3)
    assert.ok(a4 instanceof math.Matrix)
    assert.deepStrictEqual(a4.size(), [2, 2])
    assert.deepStrictEqual(a4.valueOf(), [[1, 2], [3, 0]])
    const a5 = math.pow(a2, 2)
    assert.ok(a5 instanceof math.Matrix)
    assert.deepStrictEqual(a5.size(), [2, 2])
    assert.deepStrictEqual(a5.valueOf(), [[7, 10], [15, 22]])
  })

  it('should bitwise and a scalar and a matrix correctly', function () {
    assert.deepStrictEqual(bitAnd(12, math.matrix([3, 9])), math.matrix([0, 8]))
    assert.deepStrictEqual(bitAnd(math.matrix([3, 9]), 12), math.matrix([0, 8]))
  })

  it('should bitwise and a scalar and an array correctly', function () {
    assert.deepStrictEqual(bitAnd(12, [3, 9]), [0, 8])
    assert.deepStrictEqual(bitAnd([3, 9], 12), [0, 8])
  })

  it('should bitwise and a matrix and an array correctly', function () {
    const a = [6, 4, 28]
    const b = math.matrix([13, 92, 101])
    const c = bitAnd(a, b)

    assert.ok(c instanceof math.Matrix)
    assert.deepStrictEqual(c, math.matrix([4, 4, 4]))
  })

  it('should throw an error in case of invalid number of arguments', function () {
    assert.throws(function () { bitAnd(1) }, /TypeError: Too few arguments/)
    assert.throws(function () { bitAnd(1, 2, 3) }, /TypeError: Too many arguments/)
  })

  it('should throw an error in case of invalid type of arguments', function () {
    assert.throws(function () { bitAnd(null, 1) }, /TypeError: Unexpected type of argument/)
    assert.throws(function () { bitAnd(new Date(), true) }, /TypeError: Unexpected type of argument/)
    assert.throws(function () { bitAnd(true, new Date()) }, /TypeError: Unexpected type of argument/)
    assert.throws(function () { bitAnd(true, undefined) }, /TypeError: Unexpected type of argument/)
    assert.throws(function () { bitAnd(undefined, true) }, /TypeError: Unexpected type of argument/)
  })

  it('should LaTeX bitAnd', function () {
    const expression = math.parse('bitAnd(4,2)')
    assert.strictEqual(expression.toTex(), '\\left(4\\&2\\right)')
  })
})