mathjs/test/unit-tests/function/arithmetic/fix.test.js

// test fix
import assert from 'assert'

import approx from '../../../../tools/approx'
import math from '../../../../src/bundleAny'
const bignumber = math.bignumber
const complex = math.complex
const fraction = math.fraction
const matrix = math.matrix
const unit = math.unit
const fix = math.fix

describe('fix', function () {
  it('should round booleans correctly', function () {
    assert.strictEqual(fix(true), 1)
    assert.strictEqual(fix(false), 0)
  })

  it('should round numbers correctly', function () {
    approx.equal(fix(0), 0)
    approx.equal(fix(1), 1)
    approx.equal(fix(1.3), 1)
    approx.equal(fix(1.8), 1)
    approx.equal(fix(2), 2)
    approx.equal(fix(-1), -1)
    approx.equal(fix(-1.3), -1)
    approx.equal(fix(-1.8), -1)
    approx.equal(fix(-2), -2)
    approx.equal(fix(-2.1), -2)
    approx.equal(fix(math.pi), 3)
  })

  it('should round big numbers correctly', function () {
    assert.deepStrictEqual(fix(bignumber(0)), bignumber(0))
    assert.deepStrictEqual(fix(bignumber(1)), bignumber(1))
    assert.deepStrictEqual(fix(bignumber(1.3)), bignumber(1))
    assert.deepStrictEqual(fix(bignumber(1.8)), bignumber(1))
    assert.deepStrictEqual(fix(bignumber(2)), bignumber(2))
    assert.deepStrictEqual(fix(bignumber(-1)), bignumber(-1))
    assert.deepStrictEqual(fix(bignumber(-1.3)), bignumber(-1))
    assert.deepStrictEqual(fix(bignumber(-1.8)), bignumber(-1))
    assert.deepStrictEqual(fix(bignumber(-2)), bignumber(-2))
    assert.deepStrictEqual(fix(bignumber(-2.1)), bignumber(-2))
  })

  it('should round complex numbers correctly', function () {
    // complex
    approx.deepEqual(fix(complex(0, 0)), complex(0, 0))
    approx.deepEqual(fix(complex(1.3, 1.8)), complex(1, 1))
    approx.deepEqual(fix(math.i), complex(0, 1))
    approx.deepEqual(fix(complex(-1.3, -1.8)), complex(-1, -1))
  })

  it('should round fractions correctly', function () {
    const a = fraction('2/3')
    assert(fix(a) instanceof math.Fraction)
    assert.strictEqual(a.toString(), '0.(6)')

    assert.strictEqual(fix(fraction(0)).toString(), '0')
    assert.strictEqual(fix(fraction(1)).toString(), '1')
    assert.strictEqual(fix(fraction(1.3)).toString(), '1')
    assert.strictEqual(fix(fraction(1.8)).toString(), '1')
    assert.strictEqual(fix(fraction(2)).toString(), '2')
    assert.strictEqual(fix(fraction(-1)).toString(), '-1')
    assert.strictEqual(fix(fraction(-1.3)).toString(), '-1')
    assert.strictEqual(fix(fraction(-1.8)).toString(), '-1')
    assert.strictEqual(fix(fraction(-2)).toString(), '-2')
    assert.strictEqual(fix(fraction(-2.1)).toString(), '-2')
  })

  it('should gracefully handle round-off errors', function () {
    assert.strictEqual(fix(3.0000000000000004), 3)
    assert.strictEqual(fix(7.999999999999999), 8)
    assert.strictEqual(fix(-3.0000000000000004), -3)
    assert.strictEqual(fix(-7.999999999999999), -8)
    assert.strictEqual(fix(30000.000000000004), 30000)
    assert.strictEqual(fix(799999.9999999999), 800000)
    assert.strictEqual(fix(-30000.000000000004), -30000)
    assert.strictEqual(fix(-799999.9999999999), -800000)
  })

  it('should gracefully handle round-off errors with bignumbers', function () {
    assert.deepStrictEqual(fix(bignumber(3.0000000000000004)), bignumber(3))
    assert.deepStrictEqual(fix(bignumber(7.999999999999999)), bignumber(8))
    assert.deepStrictEqual(fix(bignumber(-3.0000000000000004)), bignumber(-3))
    assert.deepStrictEqual(fix(bignumber(-7.999999999999999)), bignumber(-8))
    assert.deepStrictEqual(fix(bignumber(30000.000000000004)), bignumber(30000))
    assert.deepStrictEqual(fix(bignumber(799999.9999999999)), bignumber(800000))
    assert.deepStrictEqual(fix(bignumber(-30000.000000000004)), bignumber(-30000))
    assert.deepStrictEqual(fix(bignumber(-799999.9999999999)), bignumber(-800000))
  })

  it('should throw an error on unit as parameter', function () {
    // unit
    assert.throws(function () { fix(unit('5cm')) }, TypeError, 'Function fix(unit) not supported')
  })

  it('should convert a string to a number', function () {
    assert.strictEqual(fix('1.8'), 1)
  })

  it('should correctly round all values of a matrix element-wise', function () {
    // matrix, array, range
    approx.deepEqual(fix([1.2, 3.4, 5.6, 7.8, 10.0]), [1, 3, 5, 7, 10])
    approx.deepEqual(fix(matrix([1.2, 3.4, 5.6, 7.8, 10.0])), matrix([1, 3, 5, 7, 10]))
  })

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

  it('should throw an in case of wrong type of arguments', function () {
    assert.throws(function () { fix(null) }, /TypeError: Unexpected type of argument/)
  })

  it('should LaTeX fix', function () {
    const expression = math.parse('fix(0.6)')
    assert.strictEqual(expression.toTex(), '\\mathrm{fix}\\left(0.6\\right)')
  })
})