Fix not being able to use `and` and `or` inside a function definition #3150

josdejong · 2024-02-08T08:51:02Z

The issue was that in OperatorNode, we didn't use createSubScope in case of rawArgs functions, like we do in FunctionNode.

This is needed because during evaluation of a custom defined function, we have two scopes:

"scope" holding the "global" scope variables, the values provided via math.evaluate('...', scope)
"args" holding the local function arguments of a function, like x in function f(x) = fawFunction(x)^2

When using a rawArgs function, these two scopes where merged into one using createSubScope. Without it, you get an error like "undefined symbol x". However, createSubScope copied all variables from both scopes in a new Map, which made it impossible to do assignments like (a = true) and (b = true), because the assigned variables would end up in the subscope instead of the main scope.

This PR solves this by utilizing a new wrapper Map instance, named PartitionedMap. It holds references to both scope and args. It looks and acts like a normal Map, but it keeps the two scopes separated under the hood, and hence can read/write to the right scope.

As a side effect, we're now not copying the scope anymore inside createSubScope, we only instantiate a wrapper interface around it. This improves the performance of custom defined functions 🚀.

…tion (WIP)

…artitionedMap`

…(risk of having non-overwritten methods)

josdejong · 2024-02-08T09:25:00Z

Fix published now in v12.3.2

pjanik · 2024-07-23T17:00:17Z

@josdejong, this was released as a minor version bump, but it seems to me that it's a solid breaking change.

Our app was entirely relying on the custom scopes and the createSubScope method used by it. Now it's all gone, and I'm not entirely sure if it's even possible to fix it.

Could we somehow restore support for custom scopes with custom methods instead of passing around this PartitionedMap?

josdejong · 2024-07-23T17:18:09Z

I'm sorry to hear that Piotr. Can you share a minimal example of the kind of logic that you're using and that now doesn't work anymore?

pjanik · 2024-07-23T17:55:24Z

@josdejong, thanks! I'll think about a minimal example tomorrow.

I actually managed to fix it on our side, as our custom Scope was still accessible as the .a property of the new PartitionedMap. However, I probably need to test it a bit more to ensure that our original custom scope doesn't eventually get lost. Previously, I wasn't worried about this, as our custom MathJS scope was implementing the expected interface, including:

  createSubScope() {
    return this;
  }

Now, it seems to be available as the .a property, but I suspect that if createSubScope() from src/utils/map.js is called a few times, .a might eventually reference another PartitionedMap.

Essentially, we're implementing an app with formula support, similar to a very simple spreadsheet. We rely heavily on the custom MathJS scope that exposes custom methods necessary for app-specific calculations.

We used to define our formula functions as:

someFunction: {
    evaluateRaw: (args: MathNode[], mathjs: any, scope: CustomMathJSScope) => {
      scope.customMethod()
      // ...
    }

but now they looks more like:

someFunction: {
    evaluateRaw: (args: MathNode[], mathjs: any, partitionedScope: { a: CustomMathJSScope }) => {
      const scope = partitionedScope.a;
      scope.customMethod()
      // ...
    }

pjanik · 2024-07-24T11:08:04Z

@josdejong, here's a minimal working example that uses MathJS v12.3.1:
https://jsfiddle.net/0arxye24/

The idea is to use a custom Scope class that provides .customMethod(). This used to be possible because we could control how the sub-scopes are created via .createSubScope(). In this particular example, scope is just returning itself, but it could clone itself properly. Our scope is never wrapped in some MathJS class.

I based that implementation on the fact that the official documentation described scope as an object that implements the Map interface, and also on this example (which seems to be outdated now, btw):
https://mathjs.org/examples/advanced/custom_scope_objects.js.html

I believe it would be great to still be able to provide a custom Scope implementation (even if it needs to implement this partitioning) and control how the sub-scopes are created, as in previous implementations.

josdejong · 2024-07-24T11:08:49Z

I actually managed to fix it on our side

That is good news!

In general: there should be no need to do things using const scope = partitionedScope.a, and doing that can introduce weird issues. Instead, you can get the function out of it using a getter:

someFunction: {
  evaluateRaw: (args: MathNode[], mathjs: any, scope: CustomMathJSScope) => {
    // formerly scope was an Object: 
    //     scope.customMethod()
    // now, it is a Map:
    const customMethod = partitionedScope.get('customMethod')
    customMethod()
  }
}

josdejong · 2024-07-24T11:11:19Z

Thanks for the jsfiddle. Looking into that I see that you extend the Map interface, that may indeed give difficulties when the Map internally is wrapped by another Map interface.

Isn't it possible to put your customMethod as a regular value in the Map instead? like myMap.put('customMethod', ...)

pjanik · 2024-07-24T11:27:48Z

Isn't it possible to put your customMethod as a regular value in the Map instead? like myMap.put('customMethod', ...)

In theory, it could work for some simple use cases, although I think it's not very maintainable (and not TypeScript friendly). Here's the custom scope that I'm talking about: https://github.com/concord-consortium/codap/blob/8e7fc861af3d29502d7bf23f678d05cf93c262c2/v3/src/models/formula/formula-mathjs-scope.ts

So, I'm not sure what to do with all the custom functionality implemented in this class.

josdejong · 2024-07-24T11:35:31Z

I hadn't realized that this method createSubScope() might have been used in public. It was not unit tested nor documented, except in this example custom_scope_objects.js which I hadn't seen, so I thought it was some internal left-over and did remove it, sorry.

Thanks for sharing this class with your code. I will try to understand why createSubScope is and attaching custom methods to a Map interface is needed in the first place. We may come up with a different solution for your case.

josdejong · 2024-07-24T11:36:48Z

A minimal usage example would help me understand what we're talking about. Do you have any?

pjanik · 2024-07-24T11:49:50Z

Thanks for sharing this class with your code. I will try to understand why createSubScope is and attaching custom methods to a Map interface is needed in the first place. We may come up with a different solution for your case.

Thanks.

I think the general concept is that a simple Map works for basic math evaluation. However, if you want dynamic evaluation of saved math expressions (like in a spreadsheet), the custom scope object is a powerful concept that can provide that functionality.

Therefore, I think it would be great if we could officially support these custom scopes in MathJS. This would require two things:

Custom Scope needs to implement whatever MathJS needs (e.g., Map interface + partitioning + whatever else in the future). This could be easily controlled by TypeScript interface.
Custom Scope needs to control how it's cloned when a subscope is necessary. This ensures it can return itself or clone properly, ensuring that other code always works with one class (rather than some MathJS wrapper).

A minimal usage example would help me understand what we're talking about. Do you have any?

I think this JSFiddle is the best, minimal example I can think of. Of course, it's not very useful by itself.

In a real-life scenario, think about a spreadsheet where formulas are evaluated using MathJS. Some of the custom functions might modify what scope.get("someKey") returns during a single expression evaluation (e.g., providing some cached values). Some complex behaviors would be difficult to achieve with regular, basic maps used as scopes.

josdejong · 2024-07-24T11:52:55Z

Can you explain what the need is to pass these custom methods, attached to the Map interface, towards a "someFunction"?

i.e. isn't it possible to do something like the following?

const context = {
  customMethod: () => { ... }
}

someFunction: {
  evaluateRaw: (args: MathNode[], mathjs: any, partitionedScope: { a: CustomMathJSScope }) => {
    context.customMethod()
  }
}

Or is this customMethod dynamic or so?

pjanik · 2024-07-24T12:06:00Z

It's hard to explain all that in isolation.

But maybe I can give another, simpler example - even our .get(key) method is way more complex than regular Map.get():
https://github.com/concord-consortium/codap/blob/8e7fc861af3d29502d7bf23f678d05cf93c262c2/v3/src/models/formula/formula-mathjs-scope.ts#L62-L110

We do not want to pre-populate Map instance with all possible key-values, as this would be a huge performance hit and generally not reasonable in our scenario. So, our custom .get() method looks for the required key and calculates value lazily (and then caches it). This is not something we can do with regular Map.

josdejong · 2024-07-24T12:24:52Z

But that complexity is nicely contained inside the Map implementation behind the regular .get() method, right?

I think the core of the issue is that you want to attach and invoke custom methods on a Map interface, like scope.customMethod(). Then the question is, is there an alternative way to provide the function where you need to invoke these custom methods? ie. pass a context with these custom methods to your custom someFunction.

UPDATE: and my second question is: why are these custom methods needed in the first place, why isn't the Map interface with get/set enough? (I'm not criticizing or anything but just trying to understand the use case😅 )

pjanik · 2024-07-24T13:27:59Z

But that complexity is nicely contained inside the Map implementation behind the regular .get() method, right?

Assuming that my custom Map is allowed (as the documentation changed from scope: Object to scope: Map) and it will always be maintained at the top of the map hierarchy, and MathJS never assumes it's a regular Map and e.g. tries to clone it, then yes, you're right. So, it all depends on whether we're pretending to be a Map (and MathJS thinks it's a native Map that can be wrapped in another Map or class) or if we're explicitly allowed to use a custom class implementing the Map interface and MathJS respects that.

Then the question is, is there an alternative way to provide the function where you need to invoke these custom methods? ie. pass a context with these custom methods to your custom someFunction.

This is difficult for me to answer without spending some significant time on refactoring. I bet it's possible (as almost everything is possible 😉), but it's probably not pretty. Since the formulas are evaluated like:

  const compiledFormula = math.compile(formula)
  const result = compiledFormula.evaluate(scope)

and custom functions are defined in a clean, stateless way:

const customFunction = (args, mathjs, scope) => { ... }

I don't see a better place for custom functionality than this custom scope, as that's the only context that we actually control. Setting a module or global variable isn't a pretty approach, even though it could work. Another non-pretty approach would be to do scope.set("objectWithCustomMethods", objectWithCustomMethods) and then get it inside the function. So surely there are ways. But not necessarily ones that I'd like to use. But I'd need to think about it more. It's a bit difficult for me atm too, as I cannot spend more time on such experiments and refactoring on our side.

and my second question is: why are these custom methods needed in the first place, why isn't the Map interface with get/set enough? (I'm not criticizing or anything but just trying to understand the use case😅 )

Imagine our custom scope has two methods: scope.enableCaching() and scope.disableCaching(). These methods toggle a flag that affects how scope.get() works. Achieving this is difficult when working with an object limited to the Map interface and a separate object with custom methods. While we could do scope.set("__secret_key__cachingEnabled", true), this is not a long-term solution. I would rather explore other options than be forced to implement most of the functionality in this way.

josdejong · 2024-07-24T14:16:48Z

Assuming that my custom Map is allowed (as the documentation changed from scope: Object to scope: Map) and it will always be maintained at the top of the map hierarchy, and MathJS never assumes it's a regular Map and e.g. tries to clone it, then yes, you're right.

That is indeed the case: mathjs does not clone or copy the scope, it only wraps around it to add a sub-scope on top of it for keeping say the variable x in a custom defined function f(x) = x^2 when executing this function. The old implementation indeed copied all variables into a new Map instance, and it did call parentScope.createSubScope() for that, but that is now not needed anymore.

Thanks for your explanation about the context, I think you're right, it sounds like the most logic way to pass context to your custom function (I expect the alternative would require jumping though hoops).

Imagine our custom scope has two methods: scope.enableCaching() and scope.disableCaching(). These methods toggle a flag that affects how scope.get() works.

Thanks, this helps me a lot understanding the case 😅 👍 . This makes sense indeed, it is very neat to keep these custom funcions are stateless/standalone. I also agree that using something like scope.set("__secret_key__cachingEnabled", true) is ugly.

So, understanding your use case now and thinking about a solution, I think your earlier solution will indeed work perfectly fine. It would be good though to write a (recursive) helper function for this I think to make it more robust, something like:

// usage:
someFunction: {
    evaluateRaw: (args: MathNode[], mathjs: any, scope: Map | PartitionedMap) => {
      const rootScope = getRootScope(scope);
      rootScope.customMethod()
      // ...
    }
}

function getRootScope(scope) {
  return isPartitionedMap(scope)
    ? getRootScope(scope.a) // recurse
    : scope
}

function isPartitionedMap(map) {
  return isMap(map) && isMap(map.a) && isMap(map.b)
}

function isMap(map) {
  // ... check existence of methods get, set, has, etc...
}

pjanik · 2024-07-24T14:47:19Z

Thanks! This recursive approach gives me peace of mind, as it should indeed be safe. Things seemed to work even without it, but I was worried that at some point, our custom scope would be buried too deep and we wouldn't find it at the .a property.

This seems safe enough for us to move forward. However, I wonder if we're still in some gray, undocumented area, and if these interfaces shouldn't be documented somewhere. I could imagine adding a few words about this in the documentation, and maybe the .a and .b names could be more descriptive, or there could be some design that hides these details from use cases like ours. But obviously, this doesn't need to happen now, just something to think about long-term.

Actually, one of the easiest approaches could be MathJS exporting getRootScope itself and ensuring it always works. This way, we wouldn't need to worry about what kind of scope we're currently dealing with, and no one would be locked into the current implementation with .a and .b properties (or whatever they become in the future).

Thanks a lot for all the responses!

josdejong · 2024-07-24T16:09:58Z

Sounds good 💪

I'll write about this in the docs, add unit tests that verify that the passed scope always is a Map or PartitionedMap, update the example custom_scope_objects.js, and see whether I can export at least helper functions isMap and isPartitionedMap.

I'll give a refactoring of the PartitionedMap some more thought too, maybe expose two getters for the two internal maps but it is indeed not the biggest concern right now.

For your solution: I would also add an extra check in the code to verify whether getRootScope() indeed returned a FormulaMathJsScope instance, and if not throw an exception that you can capture in unit tests. That should guard against a new type of Map instance is added in the future that requires a different way to get to the root scope (I can't think of anything in that direction but you never know).

…tWrappingMap` and improve the documentation of `scope` (see #3150)

…ope` (#3243) * feat: export util functions `isMap`, `isPartitionedMap`, and `isObjectWrappingMap` and improve the documentation of `scope` (see #3150) * chore: fix broken unit tests * docs: refine the explanation about scopes

* 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 <wjosdejong@gmail.com> * 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 <brooks.smith@clearcalcs.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <david.contreras@guentner.com> Co-authored-by: Jos de Jong <wjosdejong@gmail.com> * 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 <david.contreras@guentner.com> Co-authored-by: Jos de Jong <wjosdejong@gmail.com> * 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 <richmartinez@Edinas-MacBook-Pro.local> Co-authored-by: Jos de Jong <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 `fraction.js@4.3.7` * 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 `typed-function@4.2.1` * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * chore: update history * chore: add tea.yaml file * docs: spelling fixes in the embedded docs (josdejong#3252) Co-authored-by: Jos de Jong <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 <wjosdejong@gmail.com> * 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 `typescript@5.5.4` to keep the (old) eslint version happy --------- Co-authored-by: Glen Whitney <glen@studioinfinity.org> Co-authored-by: Jos de Jong <wjosdejong@gmail.com> Co-authored-by: Vincent Tam <VincentTam@users.noreply.github.com> Co-authored-by: Vrushaket Chaudhari <82214275+vrushaket@users.noreply.github.com> Co-authored-by: Juan Pablo Alvarado <63080419+juancodeaudio@users.noreply.github.com> Co-authored-by: Brooks Smith <brooks.smith@clearcalcs.com> Co-authored-by: Alex Edgcomb <aedgcomb@gmail.com> Co-authored-by: Carl Osterwisch <costerwi@gmail.com> Co-authored-by: S.Y. Lee <sylee957@gmail.com> Co-authored-by: David Contreras <dvd.cnt@gmail.com> Co-authored-by: David Contreras <david.contreras@guentner.com> Co-authored-by: Hudsxn <143907857+Hudsxn@users.noreply.github.com> Co-authored-by: Rich Martinez <6185506+rich-martinez@users.noreply.github.com> Co-authored-by: Rich Martinez <richmartinez@Edinas-MacBook-Pro.local> Co-authored-by: RandomGamingDev <83996185+RandomGamingDev@users.noreply.github.com> Co-authored-by: Brian Fugate <fugateb@yahoo.com> Co-authored-by: Sukka <isukkaw@gmail.com> Co-authored-by: Rohil Shah <shah5963@gmail.com> Co-authored-by: Laurent Gérin <41303636+lgerin@users.noreply.github.com> Co-authored-by: Adam Jones <domdomegg+git@gmail.com> Co-authored-by: Lucas Eng <lucaseng19@gmail.com> Co-authored-by: Orel Ben Neriah <77707952+orelbn@users.noreply.github.com> Co-authored-by: Vistinum <eugene225@gmail.com> Co-authored-by: Vas Sudanagunta <vas@commonkarma.org> Co-authored-by: Brooks Smith <42363318+smith120bh@users.noreply.github.com> Co-authored-by: Jmar L. Pineda <63294460+Galm007@users.noreply.github.com>

josdejong added 7 commits January 31, 2024 12:41

chore: write unit tests using and and or inside a function defini…

7e59c88

…tion (WIP)

Merge branch 'develop' into fix/issue3143

fb012fd

fix: #3143 fix scope issues in rawArgs functions by implementing a `P…

1891103

…artitionedMap`

Merge branch 'develop' into fix/issue3143

88aff09

fix: add more unit tests for ObjectWrappingMap

3daa70b

fix: don't let ObjectWrappingMap and PartitionedMap extend Map …

493665f

…(risk of having non-overwritten methods)

docs: update docs about rawArgs functions

6715f2e

josdejong merged commit 5a4f60f into develop Feb 8, 2024
9 checks passed

josdejong deleted the fix/issue3143 branch February 8, 2024 08:53

pjanik mentioned this pull request Jul 23, 2024

Update MathJS to v12.4.3 and handle the new approach to scope/partitioned map concord-consortium/codap#1371

Merged

josdejong added a commit that referenced this pull request Jul 31, 2024

feat: export util functions isMap, isPartitionedMap, and `isObjec…

5156d9c

…tWrappingMap` and improve the documentation of `scope` (see #3150)

josdejong mentioned this pull request Jul 31, 2024

feat: export util functions for maps and improve documentation of scope #3243

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix not being able to use `and` and `or` inside a function definition #3150

Fix not being able to use `and` and `or` inside a function definition #3150

Fix not being able to use and and or inside a function definition #3150

Fix not being able to use and and or inside a function definition #3150

Conversation

Fix not being able to use `and` and `or` inside a function definition #3150

Fix not being able to use `and` and `or` inside a function definition #3150