Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduced callback #3256

Merged
merged 17 commits into from
Sep 11, 2024
Merged

Reduced callback #3256

merged 17 commits into from
Sep 11, 2024

Conversation

dvd101x
Copy link
Collaborator

@dvd101x dvd101x commented Aug 28, 2024

Hi Jos,

This is an idea to split the function applyCallback in a way that instead of checking the logic on each iteration, it provides a reduced or simplified callback with the intention that each iteration runs faster.

It's currently implemented on map, forEach, filter, dense (.map and .forEach) and sparse (.map and .forEach)

Here are the results

name mean v13.1.1 [ms] std v13.1.1 [ms] mean PR [ms] std PR [ms] Improvement
square 16.32 0.71 15.6 0.65 4.41%
map function 18.27 0.53 15.81 0.53 13.46%
map typed single 54.76 0.65 30.96 0.65 43.46%
map typed multiple 95.53 0.63 47.91 0.4 49.85%
mapDense function 24.03 0.41 21.48 0.54 10.61%
mapDense typed single 69.36 0.59 36.69 0.54 47.10%
mapDense typed multiple 101.42 0.52 53.45 0.52 47.30%
mapSparse function 20.43 0.56 16.41 0.7 19.68%
mapSparse typed single 64.6 0.6 31.9 0.66 50.62%
mapSparse typed multiple 96.45 0.72 48.84 0.65 49.36%

The results show a higher improvement for typed functions as it does some tricks with the signatures that are applied from the beginning. For regular functions the main improvement is that it doesn't check if they are typed on each iteration.

This PR is missing updates on jsdocs and it's not implemented on the transform functions.

Appendix

Ran on an M1 MacBook Air on Safari
Squaring 500 x 500 random numbers and taking a sample of 100 trials with a warmup of 10 trials.

const table = document.querySelector('#tests')

const size = [500, 500]
const a = math.random(size)
const aDense = math.matrix(a, 'dense')
const aSparse = math.matrix(a, 'sparse')

test('square', () => math.dotPow(a, 2))
test('map function', () => math.map(a, x => x**2))
test('map typed', () => math.map(a, math.typed({'number':x => x**2})))
test('map typed m', () => math.map(a, math.square))
test('mapDense function', () => aDense.map(x => x**2))
test('mapDense typed', () => aDense.map(math.typed({'number':x => x**2})))
test('mapDense typed m', () => aDense.map(math.square))
test('mapSparse function', () => aSparse.map(x => x**2))
test('mapSparse typed', () => aSparse.map(math.typed({'number':x => x**2})))
test('mapSparse typed m', () => aSparse.map(math.square))

function test(name, fn) {
    const results = testFunctionPerformance(name, fn, 10, 100)
    print(`<td>${name}</td><td>${results.mean.toFixed(2)}</td><td>${results.stdev.toFixed(2)}</td>`)
}

function testFunctionPerformance(name, fn, warmupIterations = 10, testIterations = 100) {
    // Warm-up phase
    for (let i = 0; i < warmupIterations; i++) {
        fn();
    }

    // Measurement phase
    const times = [];
    for (let i = 0; i < testIterations; i++) {
        const start = performance.now();
        fn();
        const end = performance.now();
        times.push(end - start);
    }

    // Statistics calculation
    const mean = math.mean(times);
    const stdev = math.std(times);

    return {
        name,
        mean,
        stdev
    };
}

function print(string){
    const row = document.createElement('tr')
    row.innerHTML = string
    table.append(row)
}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>math test new</title>
    <script src="../mathjs/lib/browser/math.js"></script>
    <!--
        <script src="https://unpkg.com/[email protected]/lib/browser/math.js"></script>
    -->
</head>
<body>
    <h1>Test new</h1>
    <table >
        <tbody id="tests">
            <tr><th>name</th><th>mean [ms]</th><th>std [ms]</th></tr>
        </tbody>
    </table>
</body>
<script src="mathTest.js"></script>
</html>

@josdejong
Copy link
Owner

This makes a lot of sense, thanks David. I can confirm that this PR makes these functions much faster. I also see that Firefox is doing better than Chrome, that is interesting to know.

I see you created your own benchmark suite. It may be easier to add a new file to the /test/benchmark folder, alongside the other benchmarks (they use the benchmark library.

@dvd101x
Copy link
Collaborator Author

dvd101x commented Aug 28, 2024

Thank you, Jos!

I will look into test/benchmark

The comparison between Firefox and Chrome is very interesting.

I will include the missing tests for transform functions, jsdocs and tests for utils during the weekend.

@josdejong
Copy link
Owner

I just realize there is another PR putting effort in improving map and forEach: #3251. Let's make sure to align/unify the efforts.

@dvd101x
Copy link
Collaborator Author

dvd101x commented Sep 1, 2024

Hi Jos,

The main changes are applied and this is ready for review.

The speed results for the parser show comparable improvements.

reduced callback

PD: I had an issue while attempting to run /test/benchmark with an error due to 'sylvester'

TypeError: sylvester.Matrix.datatype is not a function

Data

name mean [ms] std [ms] this mean [ms] this std [ms]
square 3.35 0.48 3.37 0.49
parser square 2.74 0.72 2.42 0.5
map function 2.31 0.46 2.48 0.5
mapDense function 3.49 0.5 3.33 0.47
mapSparse function 2.73 0.55 2.47 0.5
parser map function 2.47 0.52 2.41 0.49
parser mapDense function 3.49 0.5 3.45 0.5
parser mapSparse function 3.07 0.7 2.84 0.44
map typed 6.9 0.59 4.46 0.5
mapDense typed 10.14 0.75 5.82 0.56
mapSparse typed 9.5 0.56 5.01 0.52
parser map typed 9.68 0.51 5.02 0.57
parser mapDense typed 10.64 0.56 6.08 0.56
parser mapSparse typed 10.05 0.86 5.68 0.87
map typed m 13.78 0.73 7.36 0.48
mapDense typed m 15 0.62 8.47 0.52
mapSparse typed m 13.96 0.4 7.58 0.55
parser map typed m 14.43 0.62 7.56 0.54
parser mapDense typed m 15.36 0.52 8.69 0.56
parser mapSparse typed m 14.54 0.7 7.72 0.51

@josdejong
Copy link
Owner

wow great visualisation 😎. This PR looks really good, I like that you managed to replace all these recurse functions with a unified solution. And the performance improvements are of course great. Nice job David!

PD: I had an issue while attempting to run /test/benchmark with an error due to 'sylvester'

Someone accidentally changed sylvester.Matrix.create(fiedler) into sylvester.Matrix.create(fiedler, sylvester.Matrix.datatype()) recently and someone else didn't spot that when reviewing #3235 😉 . I've fixed it now.

Two feedbacks:

  1. Do you still want to add a file with some tests to the benchmark section? (not a requirement for me)
  2. Not a big deal, but I'm not entirely sure about the name simplifyCallback. The name makes sense but I myself directly associate that with the simplify function. How about a name preprocessCallback or optimizeCallback? If you have a strong preference for simplifyCallback though I'm fine with that.

@josdejong
Copy link
Owner

I've updated the benchmark /test/benchmark/map.js. If you want you can extend it with some tests for forEach or create a separate file for that.

@josdejong
Copy link
Owner

This test/benchmark/map.js gives the following results, confiming what you found: it doubles the performance of map.

# develop

abs(genericMatrix)                         x 54,106 ops/sec ±0.59% (96 runs sampled)
abs(array)                                 x 620,327 ops/sec ±0.51% (95 runs sampled)
abs(numberMatrix)                          x 48,865 ops/sec ±1.48% (92 runs sampled)
genericMatrix.map(abs)                     x 21,191 ops/sec ±0.62% (95 runs sampled)
numberMatrix.map(abs)                      x 19,951 ops/sec ±2.38% (94 runs sampled)
map(genericMatrix, abs)                    x 20,971 ops/sec ±0.56% (93 runs sampled)
map(numberMatrix, abs)                     x 20,036 ops/sec ±0.82% (93 runs sampled)
map(array, abs)                            x 21,609 ops/sec ±2.15% (93 runs sampled)
map(array, abs.signatures.number)          x 20,754 ops/sec ±2.60% (90 runs sampled)
genericMatrix.map(abs.signatures.number)   x 50,100 ops/sec ±1.08% (92 runs sampled)
numberMatrix.map(abs.signatures.number)    x 45,769 ops/sec ±0.94% (92 runs sampled)

# reduced-callback

abs(genericMatrix)                         x 55,721 ops/sec ±0.73% (92 runs sampled)
abs(array)                                 x 617,838 ops/sec ±1.74% (92 runs sampled)
abs(numberMatrix)                          x 50,944 ops/sec ±0.73% (93 runs sampled)
genericMatrix.map(abs)                     x 42,582 ops/sec ±0.68% (93 runs sampled)
numberMatrix.map(abs)                      x 40,060 ops/sec ±0.57% (93 runs sampled)
map(genericMatrix, abs)                    x 42,728 ops/sec ±0.55% (95 runs sampled)
map(numberMatrix, abs)                     x 39,682 ops/sec ±0.78% (94 runs sampled)
map(array, abs)                            x 48,888 ops/sec ±1.21% (92 runs sampled)
map(array, abs.signatures.number)          x 49,144 ops/sec ±0.85% (96 runs sampled)
genericMatrix.map(abs.signatures.number)   x 57,944 ops/sec ±0.66% (94 runs sampled)
numberMatrix.map(abs.signatures.number)    x 53,214 ops/sec ±0.64% (96 runs sampled)

There is one big outlier here: abs(array) is more than 10x faster than all other map combinations. I have opened a separate issue to discuss this, see #3262. I think it's best to first merge this PR before diving into this new optimization opportunity, one thing at a time 😁 .

@dvd101x
Copy link
Collaborator Author

dvd101x commented Sep 6, 2024

Wow!

Thanks for the thorough performance check!

After some review of #3262 I agree with you, one thing at a time. First this PR and then #3262.

@josdejong
Copy link
Owner

josdejong commented Sep 6, 2024

@dvd101x any thoughs on the latest two feedbacks in #3256 (comment) ? Besides that the PR is ready to merge.

@dvd101x
Copy link
Collaborator Author

dvd101x commented Sep 6, 2024

Oh sorry. I only read the latest comment and didn't notice there where previous ones.

Thanks for fixing the benchmark tests! Now they work for me.

  1. Yes, I will add some.
  2. Valid points, I agree. I will change the name.

@dvd101x
Copy link
Collaborator Author

dvd101x commented Sep 6, 2024

Btw. During the day I had a chance to read your comments more thoroughly and I understand what you mean about the changes that generated the Sylvester error 😅.

Someone should get better sleep to avoid making unintended errors. 😇

@dvd101x
Copy link
Collaborator Author

dvd101x commented Sep 8, 2024

Hi Jos,

This PR is ready for review.

While working on this PR I found some interesting stuff that I would like to bring to your attention:

  • I found some opportunities to merge other recurse functions, like the ones in collection.
    • Thought maybe the recurse functions should be on collection instead of array.
  • I noticed that forEach doesn't accept the third argument (array or matrix) in develop as its recurse function accepts only (value, index).
    const recurse = function (value, index) {
  • While working on the benchmark of forEach I noticed it works different in develop than in this PR. The printed output shows an object on develop and I don't know why.
  • I had some ideas to optimize the callbacks further while working on Performance issues in deepMap #3262, I tried implementing them in this PR with fewer changes and I had some promising results. I could continue here or in a new PR.

@josdejong
Copy link
Owner

Thanks for the updates.

Someone should get better sleep to avoid making unintended errors. 😇

Ha ha, we both overlooked it, and it was just a small thing in a benchmark, no problem.

  1. abouth location of the recurse function: in general my idea was to put functions that work on Arrays in array.js, and functions that can work with the mix of Arrays and Matrices in collection.js. Since the function recurse only works on Arrays I think should be in array.js, where it already is.

  2. Thanks for adding benchmarks for forEach (and spotting a mistake in the map.js benchmark that I created recently). The reason for the "objects" is that genericMatrix.forEach(abs) did throw an error before:

    TypeError: Too many arguments in function abs (expected: 1, actual: 3)
    

    So you fixed that issue as a side effect 🚀

  3. Please create a new PR to address improving deepMap. I prefer moving one step at a time and preventing to accumulate different improvments in a single PR that is then open for a long time :)

Merging this PR now, and looking forward to even more improvements in a followup PR 😎

@josdejong josdejong merged commit 367c0d3 into develop Sep 11, 2024
15 checks passed
@josdejong josdejong deleted the reduced-callback branch September 11, 2024 09:32
@dvd101x
Copy link
Collaborator Author

dvd101x commented Sep 16, 2024

Thanks!

@josdejong
Copy link
Owner

Published now in v13.2.0

gauravchawhan added a commit to gauravchawhan/mathjs that referenced this pull request Oct 14, 2024
* fix: Find eigenvectors of defective matrices (josdejong#3037)

* fix: Find eigenvectors of defective matrices

  Previously, attempting to take the `eigs` of any defective matrix
  was doomed to fail in an attempt to solve a singular linear system.
  This PR detects the situation (as best as it can given the
  inherent numerical instability of the current methods used) and
  handles it. Note that in such cases, it's not possible to return
  a square matrix whose columns are the eigenvectors corresponding to
  the returned eigenvalues. In light of that fact and issue josdejong#3014, this
  PR also changes the return value of `eigs` so that the eigenvectors
  are passed back in a property `eigenvectors` which is an array of
  plain objects `{value: e, vector: v}`.

  Note that this PR makes the ancillary changes of correcting the
  spelling of the filename which was "realSymetric.js," and replacing
  the now-unnecessary auxiliary function "createArray" therein with
  `Array(size).fill(element)`. The rationale for performing these
  changes not strictly related to the issues at hand is that this
  file is rarely touched and with the level of maintenance hours we have
  at hand, it's more efficient to do these small refactorings in parallel
  with the actual bugfixes, which are orthogonal and so will not be
  obfuscated by this refactor. Note `git diff` does properly track the
  file name change.

  However, it also makes a potentially more pervasive change: in order for
  the numerically-sensitive algorithm to work, it changes the condition
  on when two very close (double) numbers are "nearlyEqual" from differing by
  less than DBL_EPSILON to differing by less than or equal to DBL_EPSILON.
  Although this may change other behaviors than the ones primarily being
  addressed, I believe it is an acceptable change because

  (a) It preserves all tests.
  (b) DBL_EPSILON is well below the standard config.epsilon anyway
  (c) I believe there are extant issues noting the odd/inconsistent
      behavior of nearlyEqual near 0 anyway, so I believe this will
      be overhauled in the future in any case. If so, the eigenvector
      computation will make a good test that a future nearlyEqual
      algorithm is working well.

  To be clear, the direct motivation for the change is that there are
  multiple cases in the eigenvector computation in which a coefficient
  that is "supposed" to be zero comes out to precisely DBL_EPSILON, which
  is fairly unsurprising given that these coefficients are produced by
  subtracting an eigenvalue from a diagonal entry of a matrix, which is
  likely to be essentially equal to that eigenvalue.

  As many tests of defective matrices as I could readily find by web
  searching have been added as unit tests (and one more in the typescript
  type testing). An additional case I found still fails, but in the
  _eigenvalue_ computation rather than the _eigenvector_ search, so that
  was deemed beyond the scope of this PR and has been filed as issue josdejong#3036.

  Resolves josdejong#2879.
  Resolves josdejong#2927.
  Resolves josdejong#3014.

* refactor: remove comma that lint now doesn't like

* test: add a test for eigs with a precision argument

* feat: Use simple shifts in QR eigenvalue iterations that improve convergence

  Although we might want to use better shifts in the future, we might just
  use a library instead. But for now I think this:
  Resolves josdejong#2178.

  Also responds to the review feedback provided in PR josdejong#3037.

* docs: update history

* fix: josdejong#3074 improve error message when using function `max` in `derivative`

* fix: josdejong#3073 parsing quotes inside a string

* fix: josdejong#2027 cannot use named operators like `to` or `mod` as property name

* chore: update devDependencies

* chore: run `npm audit fix`

* chore: publish v11.11.2

* Drop official support for Node.js 14 and 16

* fix: change toTex variable and function assignment from `:=` to `=` (see josdejong#2980, josdejong#3032)

* Update history

* docs: fix typo in `p.set` example in the documentation of matrices (josdejong#3080)

* feat: Add option to eigs() to turn off eigenvector computation (josdejong#3057)

* feat: Add option to eigs() to turn off eigenvector computation

  For large matrices, the eigenvector computation can be noticeably expensive
  and so it's worthwhile to have a way to turn it off if the eigenvectors
  will not be used.
  Resolves josdejong#2180.

* fix: Add test for precision in options arg of eigs

  And also a fix for a small bug that the new test uncovered.

* test: check eigs with matrix and options

* refactor: remove dead code from complexEigs.js

* fix: add new signatures of eigs to typescript

* test: ensure eigenvectors property not present with eigenvectors: false option

* fix: correct balancing code in complexEigs

* Fix: josdejong#3073 escaping in strings (josdejong#3082)

* chore: refactor parsing strings to not rely on `JSON.parse`

* fix: josdejong#3073 function `format` not escaping control characters and double quotes in strings

* chore: add more unit tests

* feat: implement subtractScalar (josdejong#3081, josdejong#2643)

* added subtractScaler

* added subtractScaler missing entries

* added test cases for 2 or more parameters, test for subtractScalar instead fo subtract

* replaced subtract with subtractScalar whereever possible

---------

Co-authored-by: Jos de Jong <[email protected]>

* fix: function `clone` not throwing an error in case of an unsupported type like a function

* chore: make the unit test more robust

* fix: josdejong#2960 add type definition of function `symbolicEqual` (josdejong#3035)

* chore: update devDependencies

* chore: publish v11.12.0

* fix: josdejong#2919 TypeScript types not working with NodeNext module resolution (josdejong#3079)

* docs: update deprecation messages

* chore: publish v12.0.0

* chore: update history (forgot to mention a feature in v12)

* fix: josdejong#3088 error in the description of the return type of `pickRandom`

* fix josdejong#3087: extend function `mod` with support for negative divisors in when using `BigNumber` or `Fraction`

* fix josdejong#3092: a typo in an error message when converting a string into a number

* fix josdejong#3094: function `derivative` mutates the input expression when it fails

* feat: extend function `round` with support for units (josdejong#3095)

* fix josdejong#2761: implement support for units in function `round` (WIP)

* fix josdejong#2761: extend function `round` with support for units

* docs: describe all signatures in the docs of function round

* chore: fix linting issue

* chore: remove less-useful signatures for round with units and matrices

* chore: update devDependencies

* chore: publish v12.1.0

* docs: update the release date in history.md

* fix: josdejong#3096 embedded docs of `eigs` throwing an error

* chore: update history

* fix: accidentally passing a scope as third _and_ fourth argument to raw functions

* feat: lazy evaluation of and, or, &, |  (josdejong#3101, josdejong#3090)

* If fn has rawArgs set, pass unevaluated args

* Add shared helper function for evaluating truthiness

* Add and & or transform functions for lazy evaluation

* Add lazy evaluation of bitwise & and | operators

* Add unit tests for lazy evaluation

* Add lazy evaluation note to docs

* Move documentation to Syntax page

* Replace `testCondition()` with test evaluation
of logical function itself

* Use `isCollection()` to simplify bitwise transform functions

* fix: do not copy scope in raw OperatorNode, test lazy operators scope

* fix: linting issues

---------

Co-authored-by: Brooks Smith <[email protected]>

* docs: update history

* chore: update devDependencies

* chore: publish `v12.2.0`

* fix: josdejong#3109 method `Node.toHTML` not accepting a custom `handler`

* chore: upgrade node and Github actions versions for CI

* chore: upgrade devDependencies

* chore: publish v12.2.1

* chore: oopsie, update version number in version.js

* chore: up version number, and pin fraction.js at v4.3.4

* chore: publish v12.2.1

* docs: update maintenance badge to 2024

* docs: fix the github sponsors badge

* Support new metric prefixes: Q, R, r, and q (josdejong#3113)

* added Q, R, r, q metrix prefixes

* tests added for new prefixes

* removed duplicate tests

* maybe square and cubic tests will bump code cov into the positive

* Check numeric value

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* docs: change 2023 to 2024

* Unitless quantity conversion bug (josdejong#3117)

* Add test for conversion to unitless quantity

* Avoid access to missing array index

* Also check that other.units is not empty

* Add test for abs of dimensionless unit

* Fix: avoid access to missing units array index

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* fix `toSI()` wrongly converting `degC` (josdejong#3118)

* Add new test for degC toSI

* Convert value using to() if needed

* Only set ret.value = null when it is not already null

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: update devDependencies

* chore: publish v12.3.0

* chore: run `npm audit fix`

* Infer types of arguments more precisely (josdejong#3123)

* Prefer inferring types of nodes as tuples

* Implement for IndexNode

* Test for types

* Use tuple type for array node

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* CodeEditorExample (josdejong#3027)

* 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

* Included math to syntax when missing

* Add code editor example

* Vite mini project

* Initial example

* added alpine debounce

* Fixed display

* Added parser.clear

* Added mathjs-language

* Made module to get expressions

* Added custom events

* Issue with help formatting

* Simplified help format

* Restored package.json

* removed unneded icons

* Added readme file

* Fixed versions

* Commented getExpressions

* Documented main.js

* Fixed title

* Fixed alpine version

* Removed AlpineJS

* Added documentation and renamed variables for clarity

* Fixed naming errors

---------

Co-authored-by: David Contreras <[email protected]>
Co-authored-by: Jos de Jong <[email protected]>

* chore: minor refinement in the `code editor` example

* chore: update HISTORY.md

* fix: josdejong#3114 build warnings related to a number of wrong `/* #__PURE__ */` annotations

* chore: do not output documentation warnings unless running with a `--debug-docs` flag

* docs: update authors

* Fixed issue with long lines in Code Editor Example  (josdejong#3130)

* 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

* Included math to syntax when missing

* Add code editor example

* Vite mini project

* Initial example

* added alpine debounce

* Fixed display

* Added parser.clear

* Added mathjs-language

* Made module to get expressions

* Added custom events

* Issue with help formatting

* Simplified help format

* Restored package.json

* removed unneded icons

* Added readme file

* Fixed versions

* Commented getExpressions

* Documented main.js

* Fixed title

* Fixed alpine version

* Removed AlpineJS

* Added documentation and renamed variables for clarity

* Fixed naming errors

* Fixed issue with long lines

* Edge case where multiple expressions are on the same line not ending in ";"

---------

Co-authored-by: David Contreras <[email protected]>
Co-authored-by: Jos de Jong <[email protected]>

* docs: josdejong#3145 fix documentation about REPL, it does require a build step nowadays

* fix: josdejong#3142 support BigNumber values for the options of function `format`: `precision`, `wordSize`, `lowerExp`, `upperExp`

* Improve type definitions of function `hypot` (josdejong#3144)

* Addressed silentmissile's comment in josdejong#3125

* Added method overload to index.d.ts, have to revert commit due to changes to package-lock.json with using npm install to run the unit tests & lint tests

* chore: update HISTORY.md

* fix: josdejong#3141 `help(config)` altering the actual `config` when evaluating the examples

* chore: update devDependencies

* chore: publish `v12.3.1`

* chore: add a benchmark to get a feel for how fast scope variables are resolved

* chore: fix linting issue

* Fix not being able to use `and` and `or` inside a function definition (josdejong#3150)

* chore: write unit tests using `and` and `or` inside a function definition (WIP)

* fix: josdejong#3143 fix scope issues in rawArgs functions by implementing a `PartitionedMap`

* fix: add more unit tests for `ObjectWrappingMap`

* fix: don't let `ObjectWrappingMap` and `PartitionedMap` extend `Map` (risk of having non-overwritten methods)

* docs: update docs about `rawArgs` functions

* chore: update devDependencies

* chore: publish v12.3.2

* chore: publish v12.3.2

* fix: josdejong#3155 remove an outdated section about complex numbers from the docs

* docs: describe `getAllAsMap` in the Parser docs (josdejong#3158)

* chore: update history

* Determinant with small numbers fix (josdejong#3139)

* feat: trailing commas in matrices (josdejong#3154)

* chore: update history

* docs: fix broken example in the documentation about matrices (see josdejong#3159)

* fix: `PartitionedMap` and `ObjectWrappingMap` missing a property
  `Symbol.iterator`

* fix: linting issue

* fix: mode signature return types  (josdejong#3153)

* fix: mode type signatures

* Add ts tests for mode

* Add assertions mode type tests

* Update author Rich in AUTHORS file

---------

Co-authored-by: Rich Martinez <[email protected]>
Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* feat: improve the performance f `multiply` by adding matrix type inferencing (josdejong#3149)

* added type inference

* added back accidentally removed return statement and made it so that the explicitly defined type is returned at the end

* made sure that mixed types are ignored in the process data types check

* fixed issue with undefined _data for SparseMatrix and linting issues

* simplified syntax and added type inferencing to src/type/matrix/utils and src/function/matrix/dot.js

* shortened the final part of the type inferencing and moved it to matrix creation in multiply

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* Fix: josdejong#3100 function `round` not handling round-off errors (josdejong#3136)

* Fixing rounding bug from issue 3100

* Corrected syntax and converted if...else to logic using ternary operator

* Removing nearlyEqual comparison because a false
return value was mathematically impossible by
user input.

Adding dynamic epsilon logic to cover cases when
a user requests to round a number to a higher
precision than epsilon in the config file.

Also adding tests to cover dynamic epsilon cases.

* Removing dynamic epsilon and adding test for changing config.epsilon during runtime

* Reintroducing nearly equal verification for
round function.

Adding test case for changing epsilon at runtime.

Both tests for changing epsilon at runtime also
verify the false nearlyEqual scenario.

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: update devDependencies (most notably eslint)

* chore: publish v12.4.0

* fix josdejong#3163: `toTex` wrongly returning `Infinity` for large BigNumbers

* fix josdejong#3162: add license information about CSParse (josdejong#3164)

* update history

* fix: faster startup time of the CLI and REPL by loading the bundled file

* feat: Interactive lorenz example (josdejong#3151)

* Interactive lorenz

* Separate Interactive Lorenz

* Cleanup

* Bigger graphs

* Full screen examples

---------

Co-authored-by: Jos de Jong <[email protected]>

* fix: give the inputsDiv a white background (see josdejong#3151)

* chore: update history

* chore: remove `polyfill.io` inside example (josdejong#3167)

Co-authored-by: Jos de Jong <[email protected]>

* fix josdejong#3175: expose `math.Unit.ALIASES`, update history

* chore: update history

* doc: create CODE_OF_CONDUCT.md

See josdejong#3174

* fix: josdejong#3172 simplify `"true and true"`

* fix: josdejong#3175 cannot delete units using `math.Unit.deleteUnit`

* chore: update devDependencies

* chore: run `npm audit fix`

* chore: publish v12.4.1

* docs: fix misleading documentation for expression tree traverse (josdejong#3177)

Callback function for MathNode.traverse() returns void. Documentation says callback must return a replacement for the existing node (possibly copied from transform() above).

* chore: update history

* fix: josdejong#3180 fix type definitions of function `add` and `multiply` to allow
  more than two arguments

* chore: update devDependencies (most notably `gulp@5`)

* chore: replace utility function `values` with `Object.values` (fix josdejong#3194)

* fix josdejong#3192: function `isNaN` returns `false` for `NaN` units in a matrix or   array

* Use referToSelf() to recursively check if various types are NaN in an array or matrix

* fix array test description from isNegative to isNaN

* Add test for units in a matrix

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: update devDependencies

* chore: publish `v12.4.2`

* chore: replace util functions `values` and `contains` with using native JS functions (see josdejong#3194)

* chore: replace util functions `values` and `contains` and usages of `indexOf` with using native JS functions `values` and `contains` (see josdejong#3194)

* fix: serialization of Units without a value, see josdejong#1240

* Fix: outdated, incorrect documentation about the order of precedence for
  operator modulus `%`. See josdejong#3189

* feat: nearly equal with relative and absolute tolerance (josdejong#3152)

* nearlyEqual with absolute and relative tolerances

* Format

* nearlyEqual for bigNumber

* Added skip for NaN

* Reduce diff a bit

* Issue with examples in jsdcos

* Updated all calls for nearlyEqual

* Fixed failing tests

* Changed epsilon to relTol, absTol

* Changed references to epsilon in docs and tests

* Added warning for config.epsilon

* Fix warning in zeta.test

* Added config test

* Added sinon to test console.warn

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: move `sinon` to devDependencies and fix two typos

* chore: adjust `isPositive`, `isNegative`, and `isZero` to the new `relTol` and `absTol`

* docs: document how to run tests for the type definitions

* Improve quantileSeq typings (josdejong#3198)

* Improve quantileSeq typings

* Add tests, revert comment changes

* Fix type tests

* chore: update HISTORY.md

* chore: cleanup entry files that are deprecated since `v8.0.0` (2020-11-06)

* fix: upgrade to `[email protected]`

* chore: convert CJS files to ESM (josdejong#3204)

* chore: added test cases to deepForEach (josdejong#3211)

* feat: implement support for `bigint` (josdejong#3207, josdejong#2737)

* chore: move browserslist from package.json into `.browserslistrc`

* chore: change browerslist to browsers that are not dead and fully support es6

* chore: improve browserslist to explicity require bigint support

* chore: publish v12.4.3

* chore: update package-lock.json

* chore: update devDependencies

* chore: publish v13.0.0

* docs: document dropping JS engines that do not support E6 or bigint in v13

* fix: example advanced/custom_argument_parsing.js

* chore: add unit tests for `deepMap`, `isCollection`, and `reduce`

* docs: fix example `convert_fraction_to_bignumber.js` by upgrading to `[email protected]`

* Broadcast refactor (josdejong#3220)

* chore: update history

* fix: josdejong#3227 generated bundle containing `catch` blocks without parameters

* fix: josdejong#2348 update type definitions of the `Parser` methods (josdejong#3226)

Co-authored-by: Jos de Jong <[email protected]>

* chore: update devDependencies and run `npm audit fix`

* chore: publish v13.0.1

* Further improve quantileSeq typings (josdejong#3223)

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: update devDependencies

* fix josdejong#3227: change the minimum required JS version to ES2020 in the docs

* chore: publish v13.0.2

* chore: update dependencies of the code editor example

* fix: josdejong#3232 fix type definitions of function `format` to support notations `hex`, `bin`, and `oct`

* fix: use exact values for US liquid volume units (josdejong#3229)

1 US gallon is defined as 231 cubic inches, which is exactly 3.785411784 L (since 1 inch is defined as 25.4 mm). Other units are defined against the gallon.

Co-authored-by: Jos de Jong <[email protected]>

* fix: types static methods and members for Unit class (josdejong#3230)

* fix: types static method for Unit class

Changes unit interface to declare class to enable the adding of static methods.

* refactor: change to not using declare class

* fix: adds more unit static methods and updates tests

* chore: moves test from wrong location

* fix: adds additional static methods and updates jsDocs

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: update devDependencies

* chore: publish `v13.0.3`

* chore: update package-lock.json

* chore: revert updating devDependencies

* chore: revert reverting updating devDependencies

* chore: try use `ubuntu-24.04` instead of `ubuntu-latest`

* chore: try use `ubuntu-22.04` instead of `ubuntu-24.04`

* chore: try use `ubuntu-latest` instead of `ubuntu-22.04` again

* chore: disable testing on Node 22 for now until we get mocha working again in GitHub actions

* chore: publish `v13.0.3` for real

* chore: enable testing on Node 22 again

* feat: add matrix datatypes in more cases (josdejong#3235)

* chore: update history

* docs: add a link to the documentation page about the syntax expression from the function `evaluate` (fix josdejong#3238)

* feat: export util functions for maps and improve documentation of `scope`  (josdejong#3243)

* feat: export util functions `isMap`, `isPartitionedMap`, and `isObjectWrappingMap` and improve the documentation of `scope` (see josdejong#3150)

* chore: fix broken unit tests

* docs: refine the explanation about scopes

* chore: update history

* fix: josdejong#3244 fix broken link to `ResultSet` in the docs about classes

* fix: function `map` not always working with matrices (josdejong#3242)

* Removed maxArgumentCount in favor of applyCallback

* Making a pure _recurse function

* Added cbrt tests, removed unnecesary changes in functions.

* Fixed main bottleneck

* Restored back function before unintended change

* Fix format

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: add tea.yaml file

* docs: spelling fixes in the embedded docs (josdejong#3252)

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* chore: add a benchmark testing `DenseMatrix.map(...)` and `DenseMatrix.forEach(...)` (see josdejong#3251)

* feat: support multiple inputs in function `map` (josdejong#3228)

* chore: update history

* chore: update devDependencies

* chore: publish `v13.1.0`

* fix: various security vulnerabilities (josdejong#3255)

* fix: disable parser functions in the CLI (security issue)

* fix: ensure `ObjectWrappingMap` doesn't allow deleting unsafe properties (security issue)

* fix: enable using methods and (safe) properties on plain arrays

* docs: update the "Less vulnerable expression parser" section in the docs

* chore: fix typos and linting issues

* chore: keep functions like `simplify` enabled in the CLI

* docs: update the security page

* fix: ensure `ObjectWrappingMap.keys` cannot list unsafe properties

* fix: when overwriting a rawArgs function with a non-rawArgs function it was still called with raw arguments

* docs: fix a typo

* chore: publish v13.1.1

* fix broken links in configuration.md (josdejong#3254)

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* fix: improve the type definitions of `ConstantNode` to support all data types (josdejong#3257)

* chore: update history

* chore: fix broken benchmark

* fix: josdejong#3259 function `symbolicEqual` missing in the TypeScript definitions

* chore: update AUTHORS file

* fix: josdejong#3259 revert the duplicate `symbolicEqual` definition and just export the existing definitions

* fix: josdejong#3246 add type definitions for function `leafCount`

* fix: josdejong#3253 cannot use identifiers containing special characters in function `derivative`

* chore: update history

* chore: extend the `map.js` benchmark

* chore: fix linting issue

* chore: improve performance of functions `map`, `filter` and `forEach` (josdejong#3256)

* Implement reduceCallback

* Add jsdocs

* implement simplifyCallback in other functions

* Moved recurse to array.js

* Format

* Separate transform callback

* forEach transform

* Renamed applyCallback to simplifyCallback

* Simplified index transform

* renamed to reducedCallback and simplifiedCallback to simpleCallback

* chore: fix linting issue

* Added forEach benchmark

* renamed simplifyCallback to optimizeCallback

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update history

* fix: josdejong#3267 implicit multiplication with a negative number and unit `in`

* feat: speed up the `map()` and `forEach()` functions in DenseMatrix.js (josdejong#3251)

* Optimize the map and forEach functions in DenseMatrix.js

* Changed index back to Array from Uint32Array and clone it using index.slice(0) instead of [...index]

* Fixed merge conflicts with the fast callback optimization

* Fixed the documentation for _forEach()

* Fixed _forEach comment and made it return an immutable index array

* Resolved DenseMatrix unit test suggestions

---------

Co-authored-by: Jos de Jong <[email protected]>

* chore: update HISTORY.md and AUTHORS

* chore: use `codecov/codecov-action`

* chore: try fix the codecov-action

* chore: try fix the codecov-action

* chore: try fix the codecov-action

* chore: try fix the codecov-action

* docs: document the syntax of `map` and `forEach` in the expression parser (josdejong#3272)

* chore: update docs

* chore: update devDependencies

* chore: publish `v13.2.0`

* chore: add a missing comma

* docs: fix a typo on the Syntax page (josdejong#3276)

* fix: update dependencies and devDependencies

* chore: cleanup unused imports

* chore: revert to `[email protected]` to keep the (old) eslint version happy

---------

Co-authored-by: Glen Whitney <[email protected]>
Co-authored-by: Jos de Jong <[email protected]>
Co-authored-by: Vincent Tam <[email protected]>
Co-authored-by: Vrushaket Chaudhari <[email protected]>
Co-authored-by: Juan Pablo Alvarado <[email protected]>
Co-authored-by: Brooks Smith <[email protected]>
Co-authored-by: Alex Edgcomb <[email protected]>
Co-authored-by: Carl Osterwisch <[email protected]>
Co-authored-by: S.Y. Lee <[email protected]>
Co-authored-by: David Contreras <[email protected]>
Co-authored-by: David Contreras <[email protected]>
Co-authored-by: Hudsxn <[email protected]>
Co-authored-by: Rich Martinez <[email protected]>
Co-authored-by: Rich Martinez <[email protected]>
Co-authored-by: RandomGamingDev <[email protected]>
Co-authored-by: Brian Fugate <[email protected]>
Co-authored-by: Sukka <[email protected]>
Co-authored-by: Rohil Shah <[email protected]>
Co-authored-by: Laurent Gérin <[email protected]>
Co-authored-by: Adam Jones <[email protected]>
Co-authored-by: Lucas Eng <[email protected]>
Co-authored-by: Orel Ben Neriah <[email protected]>
Co-authored-by: Vistinum <[email protected]>
Co-authored-by: Vas Sudanagunta <[email protected]>
Co-authored-by: Brooks Smith <[email protected]>
Co-authored-by: Jmar L. Pineda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants