mirror of
https://github.com/josdejong/mathjs.git
synced 2025-12-08 19:46:04 +00:00
f8013cc99a
* broadcasting * Simplified broadcasting * Updated for broadcasting * Changed to camel case * Camel case and auto formating * Added comments * Skip if matrices have the same size * Fixed issue with undefined variable missing dot in `A._size` * Implemented broadcasting in all functions * Added helper functions * Added function to check for broadcasting rules * Tests for broadcasted arithmetic * Fixed issue with matrix the size of a vector * Documented and updated broadcasting * Included broadcast.test --------- Co-authored-by: David Contreras <david.contreras@guentner.com> Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
201 lines
8.4 KiB
JavaScript
201 lines
8.4 KiB
JavaScript
// test dotMultiply (element-wise multiply)
|
|
import assert from 'assert'
|
|
|
|
import math from '../../../../src/defaultInstance.js'
|
|
import approx from '../../../../tools/approx.js'
|
|
const dotMultiply = math.dotMultiply
|
|
const divide = math.divide
|
|
const matrix = math.matrix
|
|
const sparse = math.sparse
|
|
const complex = math.complex
|
|
const unit = math.unit
|
|
|
|
describe('dotMultiply', function () {
|
|
it('should multiply 2 numbers', function () {
|
|
// number
|
|
approx.equal(dotMultiply(2, 3), 6)
|
|
approx.equal(dotMultiply(-2, 3), -6)
|
|
approx.equal(dotMultiply(-2, -3), 6)
|
|
approx.equal(dotMultiply(5, 0), 0)
|
|
approx.equal(dotMultiply(0, 5), 0)
|
|
})
|
|
|
|
it('should multiply booleans', function () {
|
|
assert.strictEqual(dotMultiply(true, true), 1)
|
|
assert.strictEqual(dotMultiply(true, false), 0)
|
|
assert.strictEqual(dotMultiply(false, true), 0)
|
|
assert.strictEqual(dotMultiply(false, false), 0)
|
|
})
|
|
|
|
it('should multiply mixed numbers and booleans', function () {
|
|
assert.strictEqual(dotMultiply(2, true), 2)
|
|
assert.strictEqual(dotMultiply(2, false), 0)
|
|
assert.strictEqual(dotMultiply(true, 2), 2)
|
|
assert.strictEqual(dotMultiply(false, 2), 0)
|
|
})
|
|
|
|
it('should multiply 2 complex numbers', function () {
|
|
// complex
|
|
approx.deepEqual(dotMultiply(complex(2, 3), 2), complex(4, 6))
|
|
approx.deepEqual(dotMultiply(complex(2, -3), 2), complex(4, -6))
|
|
approx.deepEqual(dotMultiply(complex(0, 1), complex(2, 3)), complex(-3, 2))
|
|
approx.deepEqual(dotMultiply(complex(2, 3), complex(2, 3)), complex(-5, 12))
|
|
approx.deepEqual(dotMultiply(2, complex(2, 3)), complex(4, 6))
|
|
approx.deepEqual(divide(complex(-5, 12), complex(2, 3)), complex(2, 3))
|
|
})
|
|
|
|
it('should multiply a unit by a number', function () {
|
|
// unit
|
|
assert.strictEqual(dotMultiply(2, unit('5 mm')).toString(), '10 mm')
|
|
assert.strictEqual(dotMultiply(2, unit('5 mm')).toString(), '10 mm')
|
|
assert.strictEqual(dotMultiply(unit('5 mm'), 2).toString(), '10 mm')
|
|
assert.strictEqual(dotMultiply(unit('5 mm'), 0).toString(), '0 mm')
|
|
})
|
|
|
|
it('should throw an error with strings', function () {
|
|
// string
|
|
assert.throws(function () { dotMultiply('hello', 'world') })
|
|
assert.throws(function () { dotMultiply('hello', 2) })
|
|
})
|
|
|
|
it('should throw an in case of wrong type of arguments', function () {
|
|
assert.throws(function () { dotMultiply(null, 1) }, /TypeError: Unexpected type of argument/)
|
|
})
|
|
|
|
describe('Array', function () {
|
|
const a = [[1, 0], [3, 4]]
|
|
const b = [[5, 6], [0, 8]]
|
|
const c = [[5], [6]]
|
|
const d = [[5, 6]]
|
|
const e = [[1, 2, 3]]
|
|
const f = [[1], [2], [3]]
|
|
|
|
it('should multiply a all elements in a array by a number', function () {
|
|
// matrix, array, range
|
|
approx.deepEqual(dotMultiply(a, 3), [[3, 0], [9, 12]])
|
|
approx.deepEqual(dotMultiply(3, a), [[3, 0], [9, 12]])
|
|
approx.deepEqual(dotMultiply([1, 2, 3, 4], 2), [2, 4, 6, 8])
|
|
approx.deepEqual(dotMultiply(2, [1, 2, 3, 4]), [2, 4, 6, 8])
|
|
})
|
|
|
|
it('should multiply broadcastable arrays element-wise', function () {
|
|
const a2 = [1, 2]
|
|
const a3 = [[3], [4]]
|
|
const a4 = dotMultiply(a2, a3)
|
|
const a5 = dotMultiply(a3, a2)
|
|
assert.deepStrictEqual(a4, [[3, 6], [4, 8]])
|
|
assert.deepStrictEqual(a5, [[3, 6], [4, 8]])
|
|
})
|
|
|
|
it('should perform element-wise (array .* array) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(a, b), [[5, 0], [0, 32]])
|
|
approx.deepEqual(dotMultiply([[1, 2], [3, 4]], [[5, 6], [7, 8]]), [[5, 12], [21, 32]])
|
|
})
|
|
|
|
it('should perform element-wise (array .* dense matrix) multiplication', function () {
|
|
approx.deepEqual(dotMultiply([[1, 2], [3, 4]], matrix([[5, 6], [7, 8]])), matrix([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should perform element-wise (array .* sparse matrix) multiplication', function () {
|
|
approx.deepEqual(dotMultiply([[1, 2], [3, 4]], sparse([[5, 6], [7, 8]])), sparse([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should throw an error if arrays are of different not broadcastable sizes', function () {
|
|
assert.throws(function () { dotMultiply(a, e) })
|
|
assert.throws(function () { dotMultiply(e, a) })
|
|
assert.throws(function () { dotMultiply(b, e) })
|
|
assert.throws(function () { dotMultiply(e, b) })
|
|
assert.throws(function () { dotMultiply(d, e) })
|
|
assert.throws(function () { dotMultiply(c, f) })
|
|
})
|
|
})
|
|
|
|
describe('DenseMatrix', function () {
|
|
const a = matrix([[1, 0], [3, 4]])
|
|
const b = matrix([[5, 6], [0, 8]])
|
|
const c = matrix([[5], [6]])
|
|
const d = matrix([[5, 6]])
|
|
const e = matrix([[1, 2, 3]])
|
|
const f = matrix([[1], [2], [3]])
|
|
|
|
it('should multiply a all elements in a dense matrix by a number', function () {
|
|
// matrix, array, range
|
|
approx.deepEqual(dotMultiply(a, 3), matrix([[3, 0], [9, 12]]))
|
|
approx.deepEqual(dotMultiply(3, a), matrix([[3, 0], [9, 12]]))
|
|
approx.deepEqual(dotMultiply(matrix([1, 2, 3, 4]), 2), matrix([2, 4, 6, 8]))
|
|
approx.deepEqual(dotMultiply(2, matrix([1, 2, 3, 4])), matrix([2, 4, 6, 8]))
|
|
})
|
|
|
|
it('should perform element-wise (dense matrix .* array) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(a, [[5, 6], [0, 8]]), matrix([[5, 0], [0, 32]]))
|
|
approx.deepEqual(dotMultiply(matrix([[1, 2], [3, 4]]), [[5, 6], [7, 8]]), matrix([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should perform element-wise (dense matrix .* dense matrix) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(matrix([[1, 2], [3, 4]]), matrix([[5, 6], [7, 8]])), matrix([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should perform element-wise (dense matrix .* sparse matrix) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(matrix([[1, 2], [3, 4]]), sparse([[5, 6], [7, 8]])), sparse([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should throw an error if arrays are of different sizes', function () {
|
|
assert.throws(function () { dotMultiply(a, e) })
|
|
assert.throws(function () { dotMultiply(e, a) })
|
|
assert.throws(function () { dotMultiply(b, e) })
|
|
assert.throws(function () { dotMultiply(e, a) })
|
|
assert.throws(function () { dotMultiply(d, e) })
|
|
assert.throws(function () { dotMultiply(c, f) })
|
|
})
|
|
})
|
|
|
|
describe('SparseMatrix', function () {
|
|
const a = sparse([[1, 0], [3, 4]])
|
|
const b = sparse([[5, 6], [0, 8]])
|
|
const c = sparse([[5], [6]])
|
|
const d = sparse([[5, 6]])
|
|
const e = sparse([[1, 2, 3]])
|
|
const f = sparse([[5], [6], [7]])
|
|
|
|
it('should multiply a all elements in a sparse matrix by a number', function () {
|
|
// matrix, array, range
|
|
approx.deepEqual(dotMultiply(a, 3), sparse([[3, 0], [9, 12]]))
|
|
approx.deepEqual(dotMultiply(3, a), sparse([[3, 0], [9, 12]]))
|
|
approx.deepEqual(dotMultiply(sparse([1, 2, 3, 4]), 2), sparse([2, 4, 6, 8]))
|
|
approx.deepEqual(dotMultiply(2, sparse([1, 2, 3, 4])), sparse([2, 4, 6, 8]))
|
|
})
|
|
|
|
it('should perform element-wise (sparse matrix .* array) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(a, [[5, 6], [0, 8]]), sparse([[5, 0], [0, 32]]))
|
|
approx.deepEqual(dotMultiply(sparse([[1, 2], [3, 4]]), [[5, 6], [7, 8]]), sparse([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should perform element-wise (sparse matrix .* dense matrix) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(sparse([[1, 2], [3, 4]]), matrix([[5, 6], [7, 8]])), sparse([[5, 12], [21, 32]]))
|
|
})
|
|
|
|
it('should perform element-wise (sparse matrix .* sparse matrix) multiplication', function () {
|
|
approx.deepEqual(dotMultiply(sparse([[0, 2], [3, 4]]), sparse([[5, 6], [0, 8]])), sparse([[0, 12], [0, 32]]))
|
|
})
|
|
|
|
it('should throw an error if arrays are of different sizes', function () {
|
|
assert.throws(function () { dotMultiply(a, e) })
|
|
assert.throws(function () { dotMultiply(e, a) })
|
|
assert.throws(function () { dotMultiply(b, e) })
|
|
assert.throws(function () { dotMultiply(e, b) })
|
|
assert.throws(function () { dotMultiply(d, e) })
|
|
assert.throws(function () { dotMultiply(c, f) })
|
|
})
|
|
})
|
|
|
|
it('should throw an error in case of invalid number of arguments', function () {
|
|
assert.throws(function () { dotMultiply(1) }, /TypeError: Too few arguments/)
|
|
assert.throws(function () { dotMultiply(1, 2, 3) }, /TypeError: Too many arguments/)
|
|
})
|
|
|
|
it('should LaTeX dotMultiply', function () {
|
|
const expression = math.parse('dotMultiply([1,2],[3,4])')
|
|
assert.strictEqual(expression.toTex(), '\\left(\\begin{bmatrix}1\\\\2\\end{bmatrix}.\\cdot\\begin{bmatrix}3\\\\4\\end{bmatrix}\\right)')
|
|
})
|
|
})
|