mathjs/test/function/bitwise/bitXor.test.js

// test bitXor
var assert = require('assert'),
    math = require('../../../index'),
    bignumber = math.bignumber,
    bitXor = math.bitXor;

describe('bitXor', function () {

  it('should xor two numbers', function () {
    assert.equal(bitXor(53, 131), 182);
    assert.equal(bitXor(2, 3), 1);
    assert.equal(bitXor(-2, 3), -3);
    assert.equal(bitXor(2, -3), -1);
    assert.equal(bitXor(-5, -3), 6);
  });

  it('should xor booleans', function () {
    assert.equal(bitXor(true, true), 0);
    assert.equal(bitXor(true, false), 1);
    assert.equal(bitXor(false, true), 1);
    assert.equal(bitXor(false, false), 0);
  });

  it('should xor numbers and null', function () {
    assert.equal(math.bitXor(null, null), 0);
    assert.equal(math.bitXor(null, 1), 1);
    assert.equal(math.bitXor(1, null), 1);
  });

  it('should xor mixed numbers and booleans', function () {
    assert.equal(bitXor(0, true), 1);
    assert.equal(bitXor(0, false), 0);
    assert.equal(bitXor(true, 0), 1);
    assert.equal(bitXor(false, 0), 0);
    assert.equal(bitXor(true, 1), 0);
    assert.equal(bitXor(false, 1), 1);
  });

  it('should bitwise xor bignumbers', function () {
    assert.deepEqual(bitXor(bignumber(1), bignumber(2)), bignumber(3));
    assert.deepEqual(bitXor(bignumber('-1.0e+31'), bignumber('-1.0e+32')), bignumber('92546795970570634164073698164736'));
    assert.deepEqual(bitXor(bignumber('1.0e+31'), bignumber('1.0e+32')), bignumber('92546795970570634164077993132032'));
    assert.deepEqual(bitXor(bignumber('-1.0e+31'), bignumber('1.0e+32')), bignumber('-92546795970570634164077993132032'));
    assert.deepEqual(bitXor(bignumber('1.0e+31'), bignumber('-1.0e+32')), bignumber('-92546795970570634164073698164736'));
  });

  it('should bitwise xor mixed numbers and bignumbers', function () {
    assert.deepEqual(bitXor(bignumber(1), 2), bignumber(3));
    assert.deepEqual(bitXor(1, bignumber(2)), bignumber(3));
    assert.deepEqual(bitXor(bignumber(7), 9), bignumber(14));
    assert.deepEqual(bitXor(7, bignumber(9)), bignumber(14));
  });

  it('should bitwise xor mixed booleans and bignumbers', function () {
    assert.deepEqual(bitXor(bignumber(1), true), bignumber(0));
    assert.deepEqual(bitXor(bignumber(1), false), bignumber(1));
    assert.deepEqual(bitXor(true, bignumber(3)), bignumber(2));
    assert.deepEqual(bitXor(false, bignumber(3)), bignumber(3));
  });

  it('should throw an error if used with a unit', function() {
    assert.throws(function () {bitXor(math.unit('5cm'), 2)}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor(2, math.unit('5cm'))}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor(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 () {
      bitXor(1.1, 1);
    }, /Integers expected in function bitXor/);
    assert.throws(function () {
      bitXor(1, 1.1);
    }, /Integers expected in function bitXor/);
    assert.throws(function () {
      bitXor(1.1, 1.1);
    }, /Integers expected in function bitXor/);
    assert.throws(function () {
      bitXor(bignumber(1.1), 1);
    }, /Integers expected in function bitXor/);
    assert.throws(function () {
      bitXor(1, bignumber(1.1));
    }, /Integers expected in function bitXor/);
    assert.throws(function () {
      bitXor(bignumber(1.1), bignumber(1));
    }, /Integers expected in function bitXor/);
    assert.throws(function () {
      bitXor(bignumber(1), bignumber(1.1));
    }, /Integers expected in function bitXor/);
  });

  it('should xor matrices correctly', function () {
    var a2 = math.matrix([[1,2],[3,4]]);
    var a3 = math.matrix([[5,6],[7,8]]);
    var a4 = bitXor(a2, a3);
    assert.ok(a4 instanceof math.type.Matrix);
    assert.deepEqual(a4.size(), [2,2]);
    assert.deepEqual(a4.valueOf(), [[4,4],[4,12]]);
    var a5 = math.pow(a2, 2);
    assert.ok(a5 instanceof math.type.Matrix);
    assert.deepEqual(a5.size(), [2,2]);
    assert.deepEqual(a5.valueOf(), [[7,10],[15,22]]);
  });

  it('should xor a scalar and a matrix correctly', function () {
    assert.deepEqual(bitXor(12, math.matrix([3,9])), math.matrix([15,5]));
    assert.deepEqual(bitXor(math.matrix([3,9]), 12), math.matrix([15,5]));
  });

  it('should xor a scalar and an array correctly', function () {
    assert.deepEqual(bitXor(12, [3,9]), [15,5]);
    assert.deepEqual(bitXor([3,9], 12), [15,5]);
  });

  it('should xor a matrix and an array correctly', function () {
    var a = [6,4,28];
    var b = math.matrix([13,92,101]);
    var c = bitXor(a, b);

    assert.ok(c instanceof math.type.Matrix);
    assert.deepEqual(c, math.matrix([11,88,121]));
  });

  it('should throw an error in case of invalid number of arguments', function () {
    assert.throws(function () {bitXor(1)}, /TypeError: Too few arguments/);
    assert.throws(function () {bitXor(1, 2, 3)}, /TypeError: Too many arguments/);
  });
  it('should throw an error in case of invalid type of arguments', function () {
    assert.throws(function () {bitXor(new Date(), true)}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor(true, new Date())}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor(true, 'foo')}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor('foo', true)}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor(true, undefined)}, /TypeError: Unexpected type of argument/);
    assert.throws(function () {bitXor(undefined, true)}, /TypeError: Unexpected type of argument/);
  });

  it('should LaTeX bitXor', function () {
    var expression = math.parse('bitXor(2,3)');
    assert.equal(expression.toTex(), '\\left({2}\\underline{|}{3}\\right)');
  });

});