95 Commits

Author SHA1 Message Date
Matt Vague
477a7be622 Improve resolve JSDoc to support returning multiple nodes 2022-04-29 08:34:08 -07:00
Matt Vague
9599459e87 Add test for resolving multiple nodes 2022-04-29 08:33:45 -07:00
Chris Chudzicki
13a3d4c198
Linting: StandardJS for src/, test/; Prettier for types/ (#2544)
* setup linting with eslint-config-standard, prettier

* [autofix] npm run lint -- --fix with new setup

* [manual] fix types/ directory errors

* [manual] fix linting errors in test/ directory

* [manual] fix single linting error in src/

* revert ts-expect-error comment change

* error on .only in mocha tests

* fix test description typo

* move some short objects to single line

* add and gitignore eslintcache

* individually suppress ts any

* set --max-warnings to 0

* extract matrices to constants

* update ts-expect-error comments
2022-04-29 12:04:01 +02:00
Glen Whitney
2f3005a6ef
fix(simplifyCore): make sure simplifyCore recurses through all binary nodes (#2462)
Moves the catchall for an arbitrary binary operator node up one level in the
  code so that it doesn't let any cases slip through.
  Resolves #2461.
2022-03-04 09:40:50 +01:00
Jos de Jong
c983008ee2 Merge branch 'symbolic_equal' of https://github.com/gwhitney/mathjs into gwhitney-symbolic_equal
# Conflicts:
#	src/expression/embeddedDocs/embeddedDocs.js
#	src/factoriesAny.js
2022-03-01 13:58:39 +01:00
Glen Whitney
1ca208cd6d
fix(simplify): Collect like factors, and cancel like terms, in sums (#2388)
* fix(simplify): Collect like factors in sums and cancel like terms in sums

  Since polynomials like `x*(2x+x^2)` are usually written out as polynomials
  `2x^2+x^3`, adds rules to be more eager to move factors into sums to
  collect like factors. To complement this, adds a rule extracting
  negative powers from a sum. Together, these accomplish canceling
  a common factor in numerator and denominator:
  (a*k + b*k^2)/k^4 -> k^-4*(a*k + b*k^2) -> a*k^-3 + b*k^-2 -> k^-3*(a + k*b)
  -> (a + k*b)/k^3

  Resolves #1423.

* fix(simplify): Adjust for #2394

* chore: Rebase and mark rules with assumptions

  This commit should update this PR to be fully compatible with the
  current development mainline. Will remove 'WIP'.

* chore(simplify): Additional test cases from PR review

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-02-28 11:05:07 +01:00
Glen Whitney
151926c75b
fix: simplify.resolve detects reference loop and throws error (#2405)
* docs: Enhance generation to pick up functions with a prefix

  For example, prior to this commit, docgenerator.js would miss
  simplify.resolve because it is not a direct key of the math
  object.

  Also incorporates any "throws" attributes in the comments into
  the generated documentation, and uses this to document the
  new error-case behavior of simplify.resolve to be added in the next
  commit.

* fix(resolve): Detect and throw errors for reference loops

  Also extends resolve to work inside all node types. Adds tests
  for both changes.

* docs: Add embedded docs for simplify.resolve et al.

  To support finding the embedded doc from the `math.simplify.resolve`
  function itself, required extending the search for objects with
  documentation one level deeper in the `help()` function. Added test for
  this search.

  Also added support for documenting throws in embedded docs.

* refactor(simplify): Move resolve and simplifyCore to top-level

  Also reverts changes searching for docs and embedded docs one level
  down in the naming hierarchy.
  Also splits tests for resolve and simplifyCore into their own files,
  reflecting their new top-level status.

* fix(resolve): Remaining changes as requested

  Also removed a stray blank line inadvertently introduced in
  docgenerator.js

* refactor: Declare resolve and simplifyCore as dependencies of simplify

  ... rather than explicitly loading them, which is unnecessary now that they
  are at top level.

* fix: Add dependencies to factoriesNumber

  Also register simplifyCore as a dependency to rationalize

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-02-28 09:58:10 +01:00
Glen Whitney
22a12567f8 feat: implement symbolicEqual function
Note for this to work in a broad variety of contexts, has to also allow
  identical expressions to cancel regardless of whether subtraction is
  always defined; but this seems safe in general, that x-x is 0 even if x
  does not generally have an additive inverse (for example, when working
  in the positive context).

  Resolves #1260.
2022-02-16 17:34:26 -08:00
Glen Whitney
7dcdad04fc
feat(simplify): Provide context option to control simplifications allowed (#2399)
* feat(simplify): Allow context option

  If the options argument has a key 'context', it value is interpreted
  as a context specifying various (non-default) properties of operators.
  This context is propagated to all rules and all matching.

  Adds some initial tests that the context option affects the behavior
  of simplify appropriately. Not all can be activated until in a future
  commit we add the ability for the application of a rule to be contingent
  on aspects of the context.

  Note that the enhanced rule matching necessary to support rules
  constrained by non-default operator properties led to a couple of
  changes to the output of rationalize() as well. Since the new output
  seemed to better match what a person would typical write for the
  rationalized form, this commit changed the test rather than attempted
  to preserve the exact prior order of terms.

* feat(simplifyCore): strip all parentheses

  Prior to this commit, simplifyCore stripped internal parentheses, but
  would leave top-level ones. But top-level parentheses don't carry any
  semantics, and no tests other than the ones that explicitly checked for
  the retention of top-level parentheses were affected by this change.
  Not making a special case for the top level also notably streamlined the
  code in simplifyCore.

  Adds tests for the new parenthesis-stripping behavior, as well as for
  other node types that were added earlier but which did not yet have
  simplifyCore tests.

* refactor(simplifyCore): Strip any node marked as trivial in context

  This replaces special-case tests for unary + and parentheses, and
  paves the way for example for 'abs' being marked trivial in a
  putative positiveContext

* refactor(simplify): Rename 'context' parameter to rules and document it.

  The new name is 'imposeContext' -- the motivation for the change is to
  distinguish the parameter for 'assuming', which will be added as a new
  parameter to control rule application based on context.

* feat(simplify): Allow context-based conditions on rule application.

  Adds a new property of rules specified as objects: `assuming`. Its
  value should be a context, and every property specified in that context
  must match the incoming context, or else the rule will not be applied.
  Updates the constant floating rules to require their operators be commutative,
  as a test of the feature, and adds a unit test for this.

* feat(simplify): annotate rules with underlying assumptions

  Also activates a number of tests of simplifications that should
  or should not occur in various contexts.

  To get all tests to pass, I could no longer find a rule ordering
  that worked in all cases, without the ability to mark an individual
  rule as applying repeatedly until just that rule stabilized. So this
  commit also adds that ability, and uses it to eliminate the tricky rule
  of expanding n1 + (n2 + n3)*(-1) to n1 + n2*(-1) + n3*(-1) late in the
  rule ordering, in favor of the more intuitive (complete) expansion of
  (n1 + n2)*(-1) to n1*(-1) + n2*(-1) early in the rule ordering, before
  constant folding and gathering of like terms.

* feat(simplify): Add contexts for specific domains

  In particular, adds a `simplify.realContext` and a `simplify.positiveContext`
  which (attempt to) guarantee that no simplifications that change the value
  of the expression, on any real number or any positive real number,
  respectively, will occur.

  Adds multiple tests for these contexts, including verification that the
  simplification in either context does not change some example values of
  any of the expressions in any simplify test.

  This testing uncovered that it is unaryPlus that must be marked as trivial
  for simplifyCore to work properly, so that marking is added as well.

* chore: Alter value consistency tests for browsers/older Node

  The problem was NaN != NaN in some JavaScripts but not others,
  so test for "both values NaN" explicitly before using deepEqual.

* fix: Implement requested changes from review

  Added documentation about scope and context in top-level algebra functions
  page; made variable name less abbreviated; performed suggested refactoring.

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-02-16 11:06:13 +01:00
Glen Whitney
790a5941c3
feat: Add leafCount function (#2411)
This function returns the number of leaves in the parse tree of an
  expression. The motivation is to provide an initial complexity measure
  that could be used to decide whether or not to apply some simplification
  rules. Docs, embedded docs, and test cases are provided.

  Resolves #2389.
2022-02-16 09:31:38 +01:00
Jos de Jong
0838448098 Fix #2408: better readable description of the object returned by rationalize 2022-02-06 11:50:58 +01:00
Glen Whitney
3c54623662
fix(simplify): Correct regression in simplify (#2394)
* fix(simplify): Correct regression in simplify

  Also adds a 'debugConsole' option to simplify() so that it is possible
  to see the effect of each rule. This was critical to identifying the problem,
  which was that recent changes ended up with `simplifyConstant` in the
  wrong position in the list of rules. Correcting that also removed the need
  for the two rules coalescing negations with constants.

  Resolves #2393.

* fix(simplify): Correct another regression based on rule ordering

  Disccovered that `x - (y-y+x)` had also stopped simplifying due
  to recent changes, again because of re-ordering of the rules. So
  added it to the tests, and fixed the rule ordering (adding a more
  extensive comment about it). A big part of the reason that rule
  ordering is so sensitive is that the reduction engine only checks
  once in each pass for each rule whether it matches. So an alternate
  fix to changing the rule ordering back would have been to re-check
  each rule after it's applied (in case its application created new
  instances of the rule) but since the re-ordering worked, that seemed
  simpler as a fix for now.
2022-01-23 09:50:17 +01:00
Glen Whitney
a2fd057831
fix(simplify): Array and object simplification (#2382)
* fix(simplify): Allow simplify to work in arrays, objects, and indexing

  Mostly ArrayNode, ObjectNode, AccessorNode, and IndexNode nodes are
  simply transparent to simplification -- they simply allow it to occur
  within subexpressions. Then main exception is that if an array or object
  is indexed by a constant, the expression can be replaced by the
  corresponding subitem, e.g. `[3,4,5][2]` simplifies to `4`.

  This at least partially resolves #1913 (see my latest comment there).

* fix(simplify): Resolve operations on constant arrays

  This involves allowing ArrayNodes containing only constant entries
  to temporarily convert to Matrix type inside of simplifyConstant, so that
  function and operator calls can occur on them.
  I also had to add a special case for the function `size` because
  it can be computed even on symbolic arrays, since the result depends
  only on the shape, not the entries.

  Deals with additional cases of #1913; unclear if there are remaining
  aspects of that issue on which further work is desirable.

* chore: fix alphabetization of dependencies

  And restores inadvertent deletion of a blank line.

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-01-15 19:43:04 +01:00
Glen Whitney
84c3abdbbb
fix(simplify): Improve collection of nonconstant like terms (#2384)
The key is that the rule-matching engine is optimized for finding matches
  on the lefts of terms, but the central term-collection rule
  `n1*n3 + n2*n3 -> (n1+n2)*n3` was written with the key common term rightmost.
  Reversing this rule to `n3*n1 + n3*n2 -> n3*(n1+n2)` therefore does most
  of the work of improving like-term collection. It also better corresponds
  to typical mathematical presentation: common terms tend to be pulled out
  to the left in common practice.

  Floating constants to the right of a product initially (before they are
  moved back to the left for human-preferred output) and ensuring that
  negations are subsumed into constants whenever possible did the rest.

  Also, rule context was not being propagated into the simplification
  engine; this commit corrects that.

  Resolves #1179.
  Resolves #1290.

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-01-15 11:47:43 +01:00
Glen Whitney
4a1bd3bf3a
fix(simplify): Leave string constants as strings. (#2372)
* fix(simplify): Leave string constants as strings.

  Note that because the `size` built-in function called on a string returns
  a Matrix, which is represented in math.js expressions as an Array, this
  commit has to add ArrayNode as a dependency of `simplify` (and hence
  also of `rationalize`).

  In addition, it requires changing the handling of ArrayNodes
  and AccessorNodes in `simplifyConstant` from "unimplemented" to just a
  pass-through (since a full implementation of simplification in Arrays and
  indexing seemed beyond the scope of this change, but `simplify` must not
  throw an error on `size("foo")`). Hence, this commit also adds skipped unit
  tests for some expressions with arrays and indexing that should ultimately
  simplify.

  It also removes the skip on the test group "should not change the value of
  numbers when converting to fractions (3)" since all of those tests already
  appear to pass.

  Resolves #2152.

  Changes the behavior in #1913 from throwing an error to allowing Arrays and
  indexes but not simplifying inside them.

* chore: Fix lint and remove explanatory comment
2022-01-12 21:16:21 +01:00
Hyeonjong
43e705e7f6
Add simplify rule (#2365)
* Add simplify rule (Fix #2156)

* Add some tests

* Add more tests

* Fix simplify rule
2021-12-29 13:19:30 +01:00
jhugman
e80995d52d
Add support for scopes with get and set methods (#2166)
* Add support for scopes with get and set methods

* Fix build for node v12

* Fixup cli and parser tests

* Add tests for simplify and evaluate

* Add example for a custom scope object

* Function calls need child scopes

* Transitionary step: Separate Safe and Scope Property calls

* Renamed identifiers in FunctionNode

* Evaluate with ObjectScopeWrapper

* Simplify tests passing

* Assume all scopes are map-like. Except parser

* Remove isMapLike check in customs.*SafeProperty() methods

* Change MapLike to Map

* Move keywords from an Object to a Set

* Move ScopeProperty functions in to scope.js

* Removed deprecation warning

* Rename scope.js to map.js

* Rename ScopeProperty to MapProperty

* Add tests and docs for map.js

* Put back the micro-optimization of function calls

* Use Map in the parser

* Called scope methods directly in cli.js

* Coercing of scope into a Map is done in Node, not evaluate

* Move createSubScope to its own file

* Fixup following self-review

* Add scope docs

* Final self-review changes

* Address reviewer comments

* Remove MapProperty witness marks

* Converted broken benchmark possibly lost in a rebase

* Use bare map as scope in benchmark

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2021-05-16 13:33:01 +02:00
Michal Grňo
2d83c394a9
fixed a link in the comments of usolveAll and lsolveAll (#2154)
* fixed a link in the comments of usolveAll

The overleaf link in `usolveAll` didn't work.

* fixed link in lsolveAll
2021-04-07 14:17:11 +02:00
Jos de Jong
1587d12389 Fix #2128: typo in docs of luSolveAll and usolveAll 2021-03-09 21:13:06 +01:00
Quentin Truong
02d36c1177
Check for equal number of arguments in simplify (#2090)
* Check for equal number of arguments when simplifying non-associative nodes

* Use === instead of ==

* Run linter and remove trailing space
2021-01-27 11:10:14 +01:00
Jos de Jong
9250f44e88 Fix #2026: introduce new option fractionsLimit in function simplify 2020-11-13 15:14:04 +01:00
Jos de Jong
488943d299 Fix #2026: have function simplify not output decimal values into fractions with very large numerator/denominator 2020-11-13 14:47:30 +01:00
Jos de Jong
6f00715754
Specify import require paths (continuation of #1941) (#1962)
* Add `.js` extension to source file imports

* Specify package `exports` in `package.json`

Specify package type as `commonjs` (It's good to be specific)

* Move all compiled scripts into `lib` directory

Remove ./number.js (You can use the compiled ones in `./lib/*`)

Tell node that the `esm` directory is type `module` and enable tree shaking.

Remove unused files from packages `files` property

* Allow importing of package.json

* Make library ESM first

* - Fix merge conflicts
- Refactor `bundleAny` into `defaultInstance.js` and `browserBundle.cjs`
- Refactor unit tests to be able to run with plain nodejs (no transpiling)
- Fix browser examples

* Fix browser and browserstack tests

* Fix running unit tests on Node 10 (which has no support for modules)

* Fix node.js examples (those are still commonjs)

* Remove the need for `browserBundle.cjs`

* Generate minified bundle only

* [Security] Bump node-fetch from 2.6.0 to 2.6.1 (#1963)

Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. **This update includes a security fix.**
- [Release notes](https://github.com/bitinn/node-fetch/releases)
- [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md)
- [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

* Cleanup console.log

* Add integration tests to test the entry points (commonjs/esm, full/number only)

* Create backward compatibility error messages in the files moved/removed since v8

* Describe breaking changes in HISTORY.md

* Bump karma from 5.2.1 to 5.2.2 (#1965)

Bumps [karma](https://github.com/karma-runner/karma) from 5.2.1 to 5.2.2.
- [Release notes](https://github.com/karma-runner/karma/releases)
- [Changelog](https://github.com/karma-runner/karma/blob/master/CHANGELOG.md)
- [Commits](https://github.com/karma-runner/karma/compare/v5.2.1...v5.2.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

Co-authored-by: Lee Langley-Rees <lee@greenimp.co.uk>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-09-20 18:01:29 +02:00
Michal Grňo
ba4ff2f9c9
Add usolveAll and lsolveAll methods (#1916)
* refactor solveValidation

* refactor usolve

* usolve algorithm implemented (for square mat.)

* added lsolve, consistent return type, fixed tests

* fixed lusolve and its tests, fixed linting issues

* added tests for usolve&lsolve, try-catch in lusolve

* put changes into separate files (u-/lsolveAll), revert changes to u-, l- and lusolve

* made *solveAll return [] for non-solvable, implemented sparse algorithms

* improved documentation for *solve(All)

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2020-08-29 13:11:16 +02:00
Nick Ewing
859cfa208a
Replace recursive calls in typed-functions with this-style calls (#1903)
* Fix #1902: typo in an example in the documentation

* Replace recursive calls in typed-functions with `this`-style calls

* Replace more recursive calls in typed-functions with `this`-style calls

* Refactor compareNatural to use this-style recursion

Co-authored-by: josdejong <wjosdejong@gmail.com>
2020-07-13 17:37:30 +02:00
Jos de Jong
23f32fae9c
Fix #1856: make the library robust against Object prototype pollution (#1860) 2020-05-18 21:33:33 +02:00
josdejong
23e38bea60 Remove all deprecated code and warnings 2020-05-06 21:57:33 +02:00
David Bramwell
88733f70af
Let simplify handle a/(b/c) (#1734)
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2020-02-04 20:34:37 +01:00
jos
1d5ad22296 Remove redundant code causing a vague error, see #1724 2020-02-04 20:30:35 +01:00
Harry Sarson
462f46947f fix qr and sign edge cases (#1670)
* fix qr and sign edge cases

qr() was throwing an error if the pivots of a matrix were zero.
This commit fixes that and ensures that the results are consistant
with wolfram alpha.

Whilst doing this I found a bug in complex.js, I have added a work
around but we should flag this upstream.

I also addressed the long standing concerns about assert statements
within the body of the qr function.

Fixes #1669
Fixes #942

* further improvements to qr and sign

mainly fixing things I got wrong in previous commit

* add array test

* fix: remove only from tests and disallow

Uses mochas `--forbid-only` flag as advised by
https://github.com/standard/standard/issues/988
2019-11-18 20:03:09 +01:00
Harry Sarson
4cfef3ac34 fix no-case-declarations lint 2019-08-21 10:09:10 +01:00
jos
d8a4f3a00a Update to standard@13.0.2 2019-07-20 13:46:31 +02:00
jos
41efed79d3 Fix #1473: remove 'use strict' in every file 2019-05-26 20:21:18 +02:00
jos
80385325d8 Fix derivative and simplify not working in numbers version 2019-05-15 21:45:43 +02:00
jos
52dfafe5be Use mathWithTransform instead of math where needed 2019-05-15 10:29:27 +02:00
jos
b4f2eb005e Merge remote-tracking branch 'origin/fix/1428' into develop
# Conflicts:
#	HISTORY.md
#	src/function/algebra/simplify.js
2019-05-04 10:07:39 +02:00
jos
33cead1327 Improved deprecation errors and warnings. Introduce lazy again for factories. 2019-04-22 09:45:57 +02:00
jos
6081360d6a Merged develop into modular_architecture 2019-04-13 16:51:51 +02:00
jos
22bec13d10 Implement number factories, dependencies. Make matrix and bignumber optional where possible 2019-04-03 09:46:44 +02:00
jos
5c263d3dff Fixed #1428: transform iterating over replaced nodes 2019-03-05 21:10:59 +01:00
sam-19
9bfdff1d06 Support pow() as an argument for derivative() (#1417)
* Support pow() as an argument for derivative()

Add support for the pow() function as an argument for math.derivative().

Fixes #1259.

* Unit tests for derivatives of pow()

* Support for derivate of pow() function
2019-03-02 10:37:43 +01:00
jos
70cbc3ec30 Replace http urls with https where supported 2019-02-27 13:08:42 +01:00
jos
e5ccd9cdf1 Remove support for factory names and dependencies containing paths 2019-02-06 11:49:09 +01:00
jos
25be459ed3 Merge math.expression.parse into math.parse 2019-02-03 20:30:43 +01:00
jos
129848f347 Flatten classes under expression.node 2019-02-02 17:52:21 +01:00
jos
869d4960f9 Create and use factory.js to import all dependencies in main instance. Deprecate all old nested index.js files. 2019-01-30 14:38:47 +01:00
jos
c42844a5d8 Flatten all type.* dependencies 2019-01-30 13:47:45 +01:00
jos
19bc1e0fce Implemented snapshot testing for all exported bundles and instances 2019-01-23 14:50:29 +01:00
jos
860555a0d8 Fix math.simplify('add(2, 3)') throwing an error 2019-01-16 10:33:46 +01:00
jos
078f1dd69f Renamed methods .eval to .evaluate, updated all docs and examples accordingly 2019-01-16 10:11:32 +01:00