docs: clarify row layout for two-dimensional matrices - #3700
Open
Hugohong258 wants to merge 1 commit into
Open
Hugohong258 wants to merge 1 commit into
Hugohong258 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The matrices guide describes the first dimension of a two-dimensional matrix as a column, which conflicts with the usual interpretation of its array representation and makes multiplication harder to understand.
Change
Clarify that the top-level elements are rows, that
sizereports rows before columns, and thatmultiply(a, b)computesa * b. Add the same row convention to themultiplyAPI documentation.Closes #2618.
Validation
npm run test:src: 6652 passing, 22 pending.npx eslint --max-warnings 0 src/function/arithmetic/multiply.js: passed.size([[0, 1, 2], [3, 4, 5]])and a 1×2 multiplied by a 2×1 matrix against the current code.npm run lintwas attempted on Windows but failed on CRLF formatting in an unchanged test file (test/typescript-tests/testTypes.ts).