mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
0db42306ec
* initial implementation of multidimensional std and var * consolidated std function into var, cleaned up the interface for var, fixed bias correction * added documentation of variable axis for std and var * updated documentation for std and var * changed the order of normalization and dimension for a three parameter input in the functions * updated documentation for var and std * add transform expressions for std and var with variable axis * added test coverage for std and var with a variable axis * update to documentation * change n dim std to use apply function * fixed tests, removed unnecessary code, updated docs * fixed typo in docs * update docs to remove a type * changed location of apply function * updated tests to use deepStrictEqual to pass linter * adding test coverage for var.transform and std.transform
125 lines
4.8 KiB
JavaScript
125 lines
4.8 KiB
JavaScript
const assert = require('assert')
|
|
const math = require('../../../src/main')
|
|
const BigNumber = math.type.BigNumber
|
|
const Complex = math.type.Complex
|
|
const DenseMatrix = math.type.DenseMatrix
|
|
const Unit = math.type.Unit
|
|
const variance = math['var']
|
|
|
|
describe('variance', function () {
|
|
it('should return the variance of numbers', function () {
|
|
assert.strictEqual(variance(5), 0)
|
|
assert.strictEqual(variance(2, 4, 6), 4)
|
|
})
|
|
|
|
it('should return the variance of big numbers', function () {
|
|
assert.deepStrictEqual(variance(new BigNumber(2), new BigNumber(4), new BigNumber(6)),
|
|
new math.type.BigNumber(4))
|
|
})
|
|
|
|
it('should return the variance of complex numbers', function () {
|
|
assert.deepStrictEqual(variance(new Complex(2, 3), new Complex(-1, 2)), new Complex(4, 3))
|
|
})
|
|
|
|
it('should return the variance of mixed numbers and complex numbers', function () {
|
|
assert.deepStrictEqual(variance(2, new Complex(-1, 3)), new Complex(0, -9))
|
|
})
|
|
|
|
it('should return the variance from an array', function () {
|
|
assert.strictEqual(variance([2, 4, 6]), 4)
|
|
assert.strictEqual(variance([5]), 0)
|
|
})
|
|
|
|
it('should return the uncorrected variance from an array', function () {
|
|
assert.strictEqual(variance([2, 4], 'uncorrected'), 1)
|
|
assert.strictEqual(variance([2, 4, 6, 8], 'uncorrected'), 5)
|
|
})
|
|
|
|
it('should return the biased variance from an array', function () {
|
|
assert.strictEqual(variance([2, 8], 'biased'), 6)
|
|
assert.strictEqual(variance([2, 4, 6, 8], 'biased'), 4)
|
|
})
|
|
|
|
it('should return NaN if any of the inputs contains NaN', function () {
|
|
assert(isNaN(variance([NaN])))
|
|
assert(isNaN(variance([1, NaN])))
|
|
assert(isNaN(variance([NaN, 1])))
|
|
assert(isNaN(variance([1, 3, NaN])))
|
|
assert(isNaN(variance([NaN, NaN, NaN])))
|
|
assert(isNaN(variance(NaN, NaN, NaN)))
|
|
})
|
|
|
|
it('should throw an error in case of unknown type of normalization', function () {
|
|
assert.throws(function () { variance([2, 8], 'foo') }, /Unknown normalization/)
|
|
})
|
|
|
|
it('should throw an error in case the dimension exceeds the matrix dimension', function () {
|
|
assert.throws(function () { variance([[2, 4, 6], [1, 3, 5]], 5) }, /Index out of range/)
|
|
})
|
|
|
|
it('should return the variance from an 1d matrix', function () {
|
|
assert.strictEqual(variance(new DenseMatrix([2, 4, 6])), 4)
|
|
assert.strictEqual(variance(new DenseMatrix([5])), 0)
|
|
})
|
|
|
|
it('should return the variance element from a 2d array', function () {
|
|
assert.deepStrictEqual(variance([
|
|
[2, 4, 6],
|
|
[1, 3, 5]
|
|
]), 3.5)
|
|
})
|
|
|
|
it('should return the variance element from a 2d matrix', function () {
|
|
assert.deepStrictEqual(variance(new DenseMatrix([
|
|
[2, 4, 6],
|
|
[1, 3, 5]
|
|
])), 3.5)
|
|
})
|
|
|
|
const inputMatrix = [ // this is a 4x3x2 matrix, full test coverage
|
|
[ [10, 200], [30, 40], [50, 60] ],
|
|
[ [70, 80], [90, 100], [180, 120] ],
|
|
[ [130, 140], [160, 150], [170, 110] ],
|
|
[ [190, 20], [210, 220], [230, 240] ]
|
|
]
|
|
|
|
it('should return the variance value along a dimension on a matrix', function () {
|
|
assert.deepStrictEqual(variance([
|
|
[2, 6],
|
|
[4, 10]], 1), [8, 18])
|
|
assert.deepStrictEqual(variance([
|
|
[2, 6],
|
|
[4, 10]], 0), [2, 8])
|
|
assert.deepStrictEqual(variance(inputMatrix, 0),
|
|
[[6000, 6000], [6225, 5825], [5825, 5825]])
|
|
assert.deepStrictEqual(variance(inputMatrix, 1),
|
|
[[400, 7600], [3433.3333333333335, 400], [433.33333333333337, 433.33333333333337], [400, 14800]])
|
|
assert.deepStrictEqual(variance(inputMatrix, 2),
|
|
[[18050, 50, 50], [50, 50, 1800], [50, 50, 1800], [14450, 50, 50]])
|
|
})
|
|
|
|
it('should throw an error if called with invalid number of arguments', function () {
|
|
assert.throws(function () { variance() })
|
|
})
|
|
|
|
it('should throw an error if called with invalid type of arguments', function () {
|
|
assert.throws(function () { variance(new Date(), 2) }, /Cannot calculate var, unexpected type of argument/)
|
|
assert.throws(function () { variance(new Unit(5, 'cm'), new Unit(10, 'cm')) }, /Cannot calculate var, unexpected type of argument/)
|
|
assert.throws(function () { variance(2, 3, null) }, /Cannot calculate var, unexpected type of argument/)
|
|
assert.throws(function () { variance([2, 3, null]) }, /Cannot calculate var, unexpected type of argument/)
|
|
assert.throws(function () { variance([[2, 4, 6], [1, 3, 5]], 'biased', 0) }, /Cannot convert "biased" to a number/)
|
|
assert.throws(function () { variance([[2, 4, 6], [1, 3, 5]], 0, new Date()) }, /Cannot calculate var, unexpected type of argument/)
|
|
})
|
|
|
|
it('should throw an error if the axis exceeds the dimension of the matrix')
|
|
|
|
it('should throw an error if called with an empty array', function () {
|
|
assert.throws(function () { variance([]) })
|
|
})
|
|
|
|
it('should LaTeX var', function () {
|
|
const expression = math.parse('var(1,2,3)')
|
|
assert.strictEqual(expression.toTex(), '\\mathrm{Var}\\left(1,2,3\\right)')
|
|
})
|
|
})
|