Added embedded docs

Author: dvd101x

src/expression/embeddedDocs/embeddedDocs.js

@@ -143,6 +143,9 @@ import { partitionSelectDocs } from './function/matrix/partitionSelect.js'
 import { rangeDocs } from './function/matrix/range.js'
 import { reshapeDocs } from './function/matrix/reshape.js'
 import { resizeDocs } from './function/matrix/resize.js'
+import { broadcastMatricesDocs } from './function/matrix/broadcastMatrices.js'
+import { broadcastToDocs } from './function/matrix/bradcastTo.js'
+import { broadcastSizesDocs } from './function/matrix/broadcastSizes.js'
 import { rotateDocs } from './function/matrix/rotate.js'
 import { rotationMatrixDocs } from './function/matrix/rotationMatrix.js'
 import { rowDocs } from './function/matrix/row.js'
@@ -481,6 +484,9 @@ export const embeddedDocs = {
   partitionSelect: partitionSelectDocs,
   range: rangeDocs,
   resize: resizeDocs,
+  broadcastMatrices: broadcastMatricesDocs,
+  broadcastTo: broadcastToDocs,
+  broadcastSizes: broadcastSizesDocs,
   reshape: reshapeDocs,
   rotate: rotateDocs,
   rotationMatrix: rotationMatrixDocs,

src/expression/embeddedDocs/function/matrix/bradcastTo.js

@@ -0,0 +1,15 @@
+export const broadcastToDocs = {
+  name: 'broadcastTo',
+  category: 'Matrix',
+  syntax: [
+    'broadcastTo(A, size)'
+  ],
+  description: 'Broadcast a matrix to a compatible size',
+  examples: [
+    'broadcastTo([1, 2, 3], [3, 3])',
+    'broadcastTo([1, 2; 3, 4], [2, 2])'
+  ],
+  seealso: [
+    'size', 'reshape', 'broadcastSizes', 'broadcastMatrices'
+  ]
+}

src/expression/embeddedDocs/function/matrix/broadcastMatrices.js

@@ -0,0 +1,15 @@
+export const broadcastMatricesDocs = {
+  name: 'broadcastMatrices',
+  category: 'Matrix',
+  syntax: [
+    'broadcastMatrices(A, B)'
+  ],
+  description: 'Broadcast two matrices to compatible sizes',
+  examples: [
+    'broadcastMatrices([1, 2, 3], [[1], [2], [3]])',
+    'broadcastMatrices([1, 2; 3, 4], [5, 6; 7, 8])'
+  ],
+  seealso: [
+    'size', 'reshape', 'broadcastSizes', 'broadcastTo'
+  ]
+}

src/expression/embeddedDocs/function/matrix/broadcastSizes.js

@@ -0,0 +1,15 @@
+export const broadcastSizesDocs = {
+  name: 'broadcastSizes',
+  category: 'Matrix',
+  syntax: [
+    'broadcastSizes(sizeA, sizeB)'
+  ],
+  description: 'Broadcast the sizes of matrices to a compatible size',
+  examples: [
+    'broadcastSizes([3, 1, 3], [3, 3])',
+    'broadcastSizes([2, 1], [2, 2])'
+  ],
+  seealso: [
+    'size', 'reshape', 'broadcastTo', 'broadcastMatrices'
+  ]
+}

src/function/matrix/broadcastSizes.js

@@ -33,12 +33,9 @@ export const createBroadcastSizes = /* #__PURE__ */ factory(name, dependencies,
       const areMatrices = collections.map(isMatrix)
       if (areMatrices.includes(true)) {
         const arrays = collections.map((c, i) => areMatrices[i] ? c.valueOf() : c)
-        const broadcastedArrays = broadcastSizes(...arrays)
-        const broadcastedCollections = broadcastedArrays.map((arr, i) => areMatrices[i] ? collections[i].create(arr) : arr)
-        return broadcastedCollections
+        return broadcastSizes(...arrays)
       }
       return broadcastSizes(...collections)
     }
-
   })
 })