mathjs/test/unit-tests/utils/array.test.js

586 lines
20 KiB
JavaScript

import assert from 'assert'
import {
arraySize,
flatten,
generalize,
identify,
reshape,
resize,
squeeze,
unsqueeze,
validate,
validateIndex
} from '../../../src/utils/array'
describe('util.array', function () {
describe('size', function () {
it('should calculate the size of a scalar', function () {
assert.deepStrictEqual(arraySize(2), [])
assert.deepStrictEqual(arraySize('string'), [])
})
it('should calculate the size of a 1-dimensional array', function () {
assert.deepStrictEqual(arraySize([]), [0])
assert.deepStrictEqual(arraySize([1]), [1])
assert.deepStrictEqual(arraySize([1, 2, 3]), [3])
})
it('should calculate the size of a 2-dimensional array', function () {
assert.deepStrictEqual(arraySize([[]]), [1, 0])
assert.deepStrictEqual(arraySize([[], []]), [2, 0])
assert.deepStrictEqual(arraySize([[1, 2], [3, 4]]), [2, 2])
assert.deepStrictEqual(arraySize([[1, 2, 3], [4, 5, 6]]), [2, 3])
})
it('should calculate the size of a 3-dimensional array', function () {
assert.deepStrictEqual(arraySize([[[]]]), [1, 1, 0])
assert.deepStrictEqual(arraySize([[[], []]]), [1, 2, 0])
assert.deepStrictEqual(arraySize([[[], []], [[], []]]), [2, 2, 0])
assert.deepStrictEqual(arraySize([[[1], [2]], [[3], [4]]]), [2, 2, 1])
assert.deepStrictEqual(arraySize([[[1, 2], [3, 4]], [[5, 6], [7, 8]]]), [2, 2, 2])
assert.deepStrictEqual(arraySize([
[[1, 2, 3, 4], [5, 6, 7, 8]],
[[1, 2, 3, 4], [5, 6, 7, 8]],
[[1, 2, 3, 4], [5, 6, 7, 8]]
]), [3, 2, 4])
})
it('should not validate whether all dimensions match', function () {
assert.deepStrictEqual(arraySize([[1, 2], [3, 4, 5]]), [2, 2])
})
})
describe('resize', function () {
it('should resize a 1 dimensional array', function () {
let a = []
// resize with a default value
a = resize(a, [3], 100)
assert.deepStrictEqual(a, [100, 100, 100])
// resize without default value
a = resize(a, [5])
assert.deepStrictEqual(a, [100, 100, 100, 0, 0])
a = resize(a, [2])
assert.deepStrictEqual(a, [100, 100])
})
it('should resize a 1 dimensional array with null as defaultValue', function () {
let a = []
// resize with default value undefined
a = resize(a, [3], null)
assert.deepStrictEqual(a, [null, null, null])
})
it('should resize a 2 dimensional array', function () {
let a = [
[0, 1],
[2, 3]
]
a = resize(a, [2, 4])
assert.deepStrictEqual(a, [
[0, 1, 0, 0],
[2, 3, 0, 0]
])
a = resize(a, [4, 4])
assert.deepStrictEqual(a, [
[0, 1, 0, 0],
[2, 3, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]
])
a = resize(a, [4, 2])
assert.deepStrictEqual(a, [
[0, 1],
[2, 3],
[0, 0],
[0, 0]
])
a = resize(a, [2, 2])
assert.deepStrictEqual(a, [
[0, 1],
[2, 3]
])
a = resize(a, [1, 1])
assert.deepStrictEqual(a, [
[0]
])
})
it('should resize a 2 dimensional array with default value', function () {
let a = [
[0, 1],
[2, 3]
]
a = resize(a, [2, 4], 100)
assert.deepStrictEqual(a, [
[0, 1, 100, 100],
[2, 3, 100, 100]
])
a = resize(a, [4, 4], 100)
assert.deepStrictEqual(a, [
[0, 1, 100, 100],
[2, 3, 100, 100],
[100, 100, 100, 100],
[100, 100, 100, 100]
])
a = resize(a, [4, 2])
assert.deepStrictEqual(a, [
[0, 1],
[2, 3],
[100, 100],
[100, 100]
])
a = resize(a, [2, 2])
assert.deepStrictEqual(a, [
[0, 1],
[2, 3]
])
a = resize(a, [1, 1])
assert.deepStrictEqual(a, [
[0]
])
})
it('should resize a 1 dimensional array to 2 dimensional', function () {
let a = [1, 2]
a = resize(a, [4], 3)
assert.deepStrictEqual(a, [1, 2, 3, 3])
a = resize(a, [4, 2], 4)
assert.deepStrictEqual(a, [
[1, 4],
[2, 4],
[3, 4],
[3, 4]
])
// without default value
let b = [1, 2]
b = resize(b, [4])
assert.deepStrictEqual(b, [1, 2, 0, 0])
b = resize(b, [4, 2])
assert.deepStrictEqual(b, [
[1, 0],
[2, 0],
[0, 0],
[0, 0]
])
// TODO: would be nicer if this returns uninit everwhere and not undefined on some places
})
it('should resize a 2 dimensional array to 1 dimensional', function () {
let a = [[1, 2], [3, 4], [5, 6], [7, 8]]
a = resize(a, [6])
assert.deepStrictEqual(a, [1, 3, 5, 7, 0, 0])
let b = [[], []]
b = resize(b, [2], 8)
assert.deepStrictEqual(b, [undefined, undefined])
let c = []
c = resize(c, [2], 8)
assert.deepStrictEqual(c, [8, 8])
})
it('should resize a 3 dimensional array', function () {
let a = []
a = resize(a, [2, 3], 5)
assert.deepStrictEqual(a, [[5, 5, 5], [5, 5, 5]])
a = resize(a, [2, 3, 2], 7)
assert.deepStrictEqual(a, [[[5, 7], [5, 7], [5, 7]], [[5, 7], [5, 7], [5, 7]]])
a = resize(a, [3, 2], 9)
assert.deepStrictEqual(a, [[5, 5], [5, 5], [9, 9]])
})
it('should resize to an empty array', function () {
let a = []
a = resize(a, [2, 3], 5)
assert.deepStrictEqual(a, [[5, 5, 5], [5, 5, 5]])
a = resize(a, [0])
assert.deepStrictEqual(a, [])
})
it('should throw an error when resizing to a scalar', function () {
let a = []
assert.throws(function () { a = resize(a, []) }, /Resizing to scalar is not supported/)
})
it('should throw an error in case of wrong type of arguments', function () {
assert.throws(function () { resize([], 2) }, /Array expected/)
assert.throws(function () { resize(2) }, /Array expected/)
})
})
describe('reshape', function () {
it('should reshape a 1 dimensional array into a 2 dimensional array', function () {
const a = [1, 2, 3, 4, 5, 6, 7, 8]
assert.deepStrictEqual(
reshape(a, [2, 4]),
[[1, 2, 3, 4],
[5, 6, 7, 8]]
)
assert.deepStrictEqual(
reshape(a, [4, 2]),
[[1, 2],
[3, 4],
[5, 6],
[7, 8]]
)
assert.deepStrictEqual(
reshape(a, [1, 8]),
[[1, 2, 3, 4, 5, 6, 7, 8]]
)
assert.deepStrictEqual(
reshape(a, [1, 1, 8]),
[[[1, 2, 3, 4, 5, 6, 7, 8]]]
)
})
it('should reshape a 2 dimensional array into a 1 dimensional array', function () {
const a = [
[0, 1],
[2, 3]
]
assert.deepStrictEqual(
reshape(a, [4]),
[0, 1, 2, 3]
)
})
it('should reshape a 3 dimensional array', function () {
const a = [[[1, 2],
[3, 4]],
[[5, 6],
[7, 8]]]
assert.deepStrictEqual(
reshape(a, [8]),
[1, 2, 3, 4, 5, 6, 7, 8]
)
assert.deepStrictEqual(
reshape(a, [2, 4]),
[[1, 2, 3, 4],
[5, 6, 7, 8]]
)
})
it('should throw an error when reshaping to a dimension with length 0', function () {
assert.throws(function () { reshape([1, 2], [0, 2]) }, /DimensionError/)
assert.throws(function () { reshape([1, 2], [2, 0]) }, /DimensionError/)
})
it('should throw an error when reshaping a non-empty array to an empty array', function () {
assert.throws(function () { reshape([1], []) }, /DimensionError/)
assert.throws(function () { reshape([1, 2], []) }, /DimensionError/)
})
it('should throw an error when reshaping to a size that differs from the original', function () {
const a = [1, 2, 3, 4, 5, 6, 7, 8, 9]
assert.deepStrictEqual(
reshape(a, [3, 3]),
[[1, 2, 3],
[4, 5, 6],
[7, 8, 9]]
)
assert.throws(function () { reshape(a, [3, 2]) }, /DimensionError/)
assert.throws(function () { reshape(a, [2, 3]) }, /DimensionError/)
assert.throws(function () { reshape(a, [3, 3, 3]) }, /DimensionError/)
assert.throws(function () { reshape(a, [3, 4]) }, /DimensionError/)
assert.throws(function () { reshape(a, [4, 3]) }, /DimensionError/)
})
it('should throw an error in case of wrong type of arguments', function () {
assert.throws(function () { reshape([], 2) }, /Array expected/)
assert.throws(function () { reshape(2) }, /Array expected/)
})
})
describe('squeeze', function () {
it('should squeeze a scalar', function () {
assert.deepStrictEqual(squeeze(2), 2)
assert.deepStrictEqual(squeeze({}), {})
assert.deepStrictEqual(squeeze('string'), 'string')
})
it('should squeeze an array', function () {
// leave zero dimensions as is
assert.deepStrictEqual(squeeze([]), [])
assert.deepStrictEqual(squeeze([[]]), [])
assert.deepStrictEqual(squeeze([[[]]]), [])
assert.deepStrictEqual(squeeze([[[], []]]), [[], []])
assert.deepStrictEqual(squeeze([[[]], [[]]]), [[[]], [[]]])
assert.deepStrictEqual(squeeze(2), 2)
assert.deepStrictEqual(squeeze([[2]]), 2)
assert.deepStrictEqual(squeeze([[[2]]]), 2)
assert.deepStrictEqual(squeeze([1, 2, 3]), [1, 2, 3])
assert.deepStrictEqual(squeeze([[1, 2, 3]]), [1, 2, 3])
assert.deepStrictEqual(squeeze([[[1, 2, 3]]]), [1, 2, 3])
assert.deepStrictEqual(squeeze([[1], [2], [3]]), [1, 2, 3])
assert.deepStrictEqual(squeeze([[1, 2], [3, 4]]), [[1, 2], [3, 4]])
assert.deepStrictEqual(squeeze([[[1, 2]], [[3, 4]]]), [[[1, 2]], [[3, 4]]])
assert.deepStrictEqual(squeeze([[[1, 2], [3, 4]]]), [[1, 2], [3, 4]])
assert.deepStrictEqual(squeeze([[[1], [2]], [[3], [4]]]), [[1, 2], [3, 4]])
assert.deepStrictEqual(squeeze([[[1]], [[2]], [[3]], [[4]]]), [1, 2, 3, 4])
})
it('should adjust size when squeezing an array', function () {
let a = [[[1], [2]], [[3], [4]]]
let size = [2, 2, 1]
a = squeeze(a, size)
assert.deepStrictEqual(a, [[1, 2], [3, 4]])
assert.deepStrictEqual(size, [2, 2])
a = [[1, 2]]
size = [1, 2]
a = squeeze(a, size)
assert.deepStrictEqual(a, [1, 2])
assert.deepStrictEqual(size, [2])
a = [[[1]], [[2]], [[3]], [[4]]]
size = [4, 1, 1]
a = squeeze(a, size)
assert.deepStrictEqual(a, [1, 2, 3, 4])
assert.deepStrictEqual(size, [4])
})
})
describe('unsqueeze', function () {
it('should unsqueeze a scalar', function () {
assert.deepStrictEqual(unsqueeze(2, 0), 2)
assert.deepStrictEqual(unsqueeze(2, 1), [2])
assert.deepStrictEqual(unsqueeze(2, 2), [[2]])
assert.deepStrictEqual(unsqueeze('string', 2), [['string']])
})
it('should ignore empty arrays in unsqueeze', function () {
// should do nothing with empty arrays
assert.deepStrictEqual(unsqueeze([], 0), [])
assert.deepStrictEqual(unsqueeze([], 1), [])
assert.deepStrictEqual(unsqueeze([], 2), [])
assert.deepStrictEqual(unsqueeze([], 3), [])
assert.deepStrictEqual(unsqueeze([[]], 0), [[]])
assert.deepStrictEqual(unsqueeze([[]], 1), [[]])
assert.deepStrictEqual(unsqueeze([[]], 2), [[]])
assert.deepStrictEqual(unsqueeze([[]], 3), [[]])
})
it('should unsqueeze an array', function () {
assert.deepStrictEqual(unsqueeze([1, 2, 3], 1), [1, 2, 3])
assert.deepStrictEqual(unsqueeze([1, 2, 3], 2), [[1], [2], [3]])
assert.deepStrictEqual(unsqueeze([1, 2, 3], 3), [[[1]], [[2]], [[3]]])
assert.deepStrictEqual(unsqueeze([1, 2, 3], 3, 1), [[[1], [2], [3]]])
assert.deepStrictEqual(unsqueeze([1, 2, 3], 3, 2), [[[1, 2, 3]]])
assert.deepStrictEqual(unsqueeze([[1, 2], [3, 4]], 1), [[1, 2], [3, 4]])
assert.deepStrictEqual(unsqueeze([[1, 2], [3, 4]], 2), [[1, 2], [3, 4]])
assert.deepStrictEqual(unsqueeze([[1, 2], [3, 4]], 3), [[[1], [2]], [[3], [4]]])
})
it('should adjust size when unsqueezing an array', function () {
let a = [[1, 2], [3, 4]]
let size = [2, 2]
unsqueeze(a, 3, 0, size)
assert.deepStrictEqual(a, [[[1], [2]], [[3], [4]]])
assert.deepStrictEqual(size, [2, 2, 1])
a = [1, 2, 3, 4]
size = [4]
unsqueeze(a, 3, 0, size)
assert.deepStrictEqual(a, [[[1]], [[2]], [[3]], [[4]]])
assert.deepStrictEqual(size, [4, 1, 1])
})
})
describe('validateIndex', function () {
it('should validate whether an index contains integers', function () {
assert.strictEqual(validateIndex(2), undefined)
assert.strictEqual(validateIndex(10), undefined)
assert.throws(function () { validateIndex(2.3) }, /Index must be an integer/)
assert.throws(function () { validateIndex('str') }, /Index must be an integer/)
assert.throws(function () { validateIndex(true) }, /Index must be an integer/)
})
it('should validate whether an index doesn\'t exceed the minimum 0', function () {
assert.strictEqual(validateIndex(2), undefined)
assert.strictEqual(validateIndex(0), undefined)
assert.throws(function () { validateIndex(-1) }, /Index out of range/)
assert.throws(function () { validateIndex(-100) }, /Index out of range/)
})
it('should validate whether an index doesn\'t exceed both minimum and maximum', function () {
assert.strictEqual(validateIndex(0, 10), undefined)
assert.strictEqual(validateIndex(4, 10), undefined)
assert.strictEqual(validateIndex(9, 10), undefined)
assert.throws(function () { validateIndex(-1, 10) }, /Index out of range/)
assert.throws(function () { validateIndex(10, 10) }, /Index out of range/)
assert.throws(function () { validateIndex(11, 10) }, /Index out of range/)
assert.throws(function () { validateIndex(100, 10) }, /Index out of range/)
})
it('thrown IndexError should contain the right index, max, and min properties', function () {
try {
validateIndex(4, 3)
assert.ok(false, 'should not reach this point')
} catch (err) {
assert.strictEqual(err.toString(), 'IndexError: Index out of range (4 > 2)')
assert.strictEqual(err.index, 4)
assert.strictEqual(err.min, 0)
assert.strictEqual(err.max, 3)
}
try {
validateIndex(-1, 3)
assert.ok(false, 'should not reach this point')
} catch (err) {
assert.strictEqual(err.toString(), 'IndexError: Index out of range (-1 < 0)')
assert.strictEqual(err.index, -1)
assert.strictEqual(err.min, 0)
assert.strictEqual(err.max, 3)
}
try {
validateIndex(-1)
assert.ok(false, 'should not reach this point')
} catch (err) {
assert.strictEqual(err.toString(), 'IndexError: Index out of range (-1 < 0)')
assert.strictEqual(err.index, -1)
assert.strictEqual(err.min, 0)
assert.strictEqual(err.max, undefined)
}
})
})
describe('validate', function () {
it('should validate whether all elements in a vector have correct size', function () {
// valid vector with correct size
assert.strictEqual(validate([], [0]), undefined)
assert.strictEqual(validate([1], [1]), undefined)
assert.strictEqual(validate([1, 2, 3], [3]), undefined)
// valid matrix but wrong size
assert.throws(function () { validate([1, 2, 3], [2]) }, /Dimension mismatch/)
assert.throws(function () { validate([1, 2, 3], [4]) }, /Dimension mismatch/)
assert.throws(function () { validate([1, 2, 3], []) }, /Dimension mismatch/)
assert.throws(function () { validate([1, 2, 3], [3, 2]) }, /Dimension mismatch/)
// invalid vector
assert.throws(function () { validate([1, [2], 3], [3]) }, /Dimension mismatch/)
})
it('should validate whether all elements in a 2d matrix have correct size', function () {
// valid matrix with correct size
assert.strictEqual(validate([[1, 2], [3, 4]], [2, 2]), undefined)
assert.strictEqual(validate([[1, 2, 3], [4, 5, 6]], [2, 3]), undefined)
assert.strictEqual(validate([[1, 2], [3, 4], [5, 6]], [3, 2]), undefined)
// valid matrix with wrong size
assert.throws(function () { validate([[1, 2], [3, 4]], [2, 1]) }, /Dimension mismatch/)
assert.throws(function () { validate([[1, 2], [3, 4]], [3, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[1, 2, 3], [4, 5, 6]], [2, 4]) }, /Dimension mismatch/)
assert.throws(function () { validate([[1, 2], [3, 4], [5, 6]], [4, 3]) }, /Dimension mismatch/)
// invalid matrix
assert.throws(function () { validate([[1, 2], [3, 4, 5]], [2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[1, 2], [3]], [2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[1, 2], 3], [2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([1, 2], [2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]]], [2, 2]) }, /Dimension mismatch/)
})
it('should validate whether all elements in a multi dimensional matrix have correct size', function () {
// valid matrix with correct size
assert.strictEqual(validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]]], [2, 2, 2]), undefined)
assert.strictEqual(validate([[[1, 2, 3], [4, 5, 6]], [[7, 8, 9], [10, 11, 12]]], [2, 2, 3]), undefined)
assert.strictEqual(validate([[[1, 2], [3, 4], [5, 6]], [[7, 8], [9, 10], [11, 12]]], [2, 3, 2]), undefined)
assert.strictEqual(validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]], [[9, 10], [11, 12]]], [3, 2, 2]), undefined)
// valid matrix with wrong size
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]]], [2, 2, 3]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]]], [2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]]], [2, 2, 2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]]], [3, 2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], [7, 8]]], [2, 3, 2]) }, /Dimension mismatch/)
// invalid matrix
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], [7, 8, 9]]], [2, 2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6, 6.5], [7, 8]]], [2, 2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [[5, 6], 7]], [2, 2, 2]) }, /Dimension mismatch/)
assert.throws(function () { validate([[[1, 2], [3, 4]], [6, [7, 8]]], [2, 2, 2]) }, /Dimension mismatch/)
})
it('should validate whether a variable contains a scalar', function () {
assert.strictEqual(validate(2.3, []), undefined)
assert.strictEqual(validate(new Date(), []), undefined)
assert.strictEqual(validate({}, []), undefined)
assert.throws(function () { validate([], []) }, /Dimension mismatch/)
assert.throws(function () { validate([1, 2, 3], []) }, /Dimension mismatch/)
assert.throws(function () { validate([[1, 2], [3, 4]], []) }, /Dimension mismatch/)
})
})
describe('flatten', function () {
it('should flatten a scalar', function () {
assert.deepStrictEqual(flatten(1), 1)
})
it('should flatten a 1 dimensional array', function () {
assert.deepStrictEqual(flatten([1, 2, 3]), [1, 2, 3])
})
it('should flatten a 2 dimensional array', function () {
assert.deepStrictEqual(flatten([[1, 2], [3, 4]]), [1, 2, 3, 4])
})
it('should flatten a 3 dimensional array', function () {
assert.deepStrictEqual(flatten([[[1, 2], [3, 4]], [[5, 6], [7, 8]]]), [1, 2, 3, 4, 5, 6, 7, 8])
})
it('should return a new array', function () {
const input = [3, 2, 1]
const flat = flatten(input)
flat.sort()
assert.deepStrictEqual(input, [3, 2, 1])
})
})
describe('identify', function () {
it('should append a unique identifier to every element of the array', function () {
assert.deepStrictEqual(identify([]), [])
assert.deepStrictEqual(identify([1, 1, 2]), [{ value: 1, identifier: 0 }, { value: 1, identifier: 1 }, { value: 2, identifier: 0 }])
})
})
describe('generalize', function () {
it('should remove the unique identifier from every element of the array', function () {
assert.deepStrictEqual(generalize([]), [])
assert.deepStrictEqual(generalize([{ value: 1, identifier: 0 }, { value: 1, identifier: 1 }, { value: 2, identifier: 0 }]), [1, 1, 2])
})
})
})