* Add option to construct a Unit from a value and
an existing Unit (that has no value). Updates the
related mathjs functions, the documentation, and tests.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
* refactor: Remove the automatic conversion from number to string. (#2482)
This is a breaking change. However, nothing in the unit tests or examples
actually depended on such a conversion, and it's difficult to construct
situations in which it's necessary. The best such example is e.g.
`count(57)` which formerly gave the number of digits in its numeric
argument. Of course, after this commit, that behavior can still be
obtained by the just slightly longer expression `count(string(57))`
The change is proposed in preparation for an addition of new facilities/
handlers to allow symbolic computation in a couple of different ways
(see #2475 and #2470).
* feat(simplifyCore): convert equivalent function calls into operators (#2466)
* feat(simplifyCore): convert equivalent function calls into operators
Resolves#2415.
* docs: Every operator has a function form
Also documents the new behavior of simplifyCore to convert function calls
into any equivalent operator form they may have. Also fixes the syntax
errors so that simplifyCore will successfully doctest.
* docs: Fix table syntax for operator->function correspondence
* fix(parse): Implement amended "Rule 2"
As per the discussion in #2370, the amended "Rule 2" is
"when having a division followed by an implicit multiplication, the
division gets higher precedence over the implicit multiplication when
(a) the numerator is a constant with optionally a
prefix operator (-, +, ~), and
(b) the denominator is a constant."
This commit implements that behavior and adds tests for it.
Resolves#2370.
* fix: OperatorNode.toString() outputs match implicit multiplication parsing
Also greatly extends the tests on OperatorNode.toString() and .toTex(), and
ensures that all tests are performed on both. (toHTML() is still a testing
stepchild.)
Also fixes other small bugs in .toString() and .toTex() revealed by the
new tests.
Resolves#1431.
* test(parse): More cases of implicit multiplication
* refactor: Alter the precedence of implicit multiplication
This greatly simplifies OperatorNode:calculateNecessaryParentheses,
as opposed to trying to correct for the change in precedence after
the fact.
* Fix broken unit test
* Replace `options && options.implicit` with `options?.implicit`
* Replace `options?.implicit` with `options && options.implicit` again, it breaks the Node 12 tests
* chore: Prevent confusion with standard matrix functions. (#2465)
* chore: Prevent consfusion with standard matrix functions.
Prior to this commit, many functions operated elementwise on matrices
even though in standard mathematical usage they have a different
meaning on square matrices. Since the elementwise operation is easily
recoverable using `math.map`, this commit removes the elementwise
operation on arrays and matrices from these functions.
Affected functions include all trigonometric functions, exp, log, gamma,
square, sqrt, cube, and cbrt.
Resolves#2440.
* chore(typescript): Revise usages in light of changes
sqrt() is now correctly typed as `number | Complex` and so must
be explicitly cast to number when called on a positive and used
where a Complex is disallowed; sqrt() no longer applies to matrices
at all.
* feat: Provide better error messages for v10 -> v11 transition
Uses new `typed.onMismatch` handler so that matrix calls that used to
work will suggest a replacement.
* Fix#2412: let function diff return an empty matrix when the input contains only one element (#2422)
* Fix#2412: let function diff return an empty matrix when the input has only one element
* Undo changes in History in this fixme
* Add TypeScript definitions for src/utils/is.js (#2432)
This is a first step toward full publication of these functions,
that were already being exported by mathjs but had not yet
had the associated actions (documentation/available in
parser/typed, etc.) Also, makes most of them into TypeScript
type guards, and adds Matrix as a constructor type. Resolved#2431.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
* test: add two-dimensional test cases for diff of length 1
Co-authored-by: Chris Chudzicki <christopher.chudzicki@gmail.com>
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
* Refactor/simplify core cleanup (#2490)
* refactor: don't simplify constants in simplifyCore
Keeps the operation of simplifyCore cleanly separate from
simplifyConstant.
* fix; handle multiple consecutive operations in simplifyCore()
Also adds support for logical operators.
Resolves#2484.
* feat: export simplifyConstant
Now that simplifyCore does not do any constant folding, clients may
wish to access that behavior via simplifyConstant. Moreover, exporting it
makes it easier to use in custom rule lists for simplify().
Also adds docs, embedded docs, and tests for simplifyConstant().
Also fixes simplifyCore() on logical functions (they always return boolean,
rather than "short-circuiting").
Resolves#2459.
* refactor: Rename matrix algorithms to stay sane in next refactor
* refactor: Create a generator for boilerplate matrix versions of operations
This reduces code length and duplication, and significantly reduces the
number of instances of 'this' that will require replacement when moving on
top of typed-function v3.
* refactor: add automatic conversion from string to Node
Eliminates many `this` calls in src/function/algebra, which will help
conversion to typed-function v3a.
Also make `resolve` into a typed function so that it will now work
on strings as well, and adds a test that it does.
* refactor: Use temporary conversions to simplify typed-function definitions
Specifically, temporarily converting Object to Map eases the definition
of 'simplify' and a new, generally ignored type 'identifier' (a subtype
of 'string') with a temporary conversion to 'SymbolNode' simplifies the
definition of 'derivative'.
These refactors eliminate multiple instances of this, which will ease
conversion to typed-function v3a.
* refactor: Speed up utils/is.js typeOf function
In preparation for using it as the function selector for the Unit class.
Also fixes the inconsistency between the `typed` type hierarchy
'function' and typeOf returning 'Function' in favor of
'function', again to minimize the special cases in typeOf
* feat(Unit): Add a method giving the (string name of the) type of the value
E.g. `math.unit('5cm').valType()` returns `number`.
Also uses this for an internal method that directly gives the number
converter for a Unit.
Also fixes lint errors from previous commit (not clean, I know, I forgot
that build-and-test does not run lint).
Adds tests for unit.valType()
* refactor: Eliminate hyperbolic functions operating on angles
There is no mathematical meaning to a hyperbolic function operating on
an angle (the proper units of its argument is actually area), and it
eliminates a number of uses of `this`, so remove such arguments.
* refactor: Remove miscellaneous unnecessary typed-function this refs
* refactor: Adapt to typed-function v3a
Mostly this involves replaceing instances of 'this' with used of (preferably)
typed.referTo() or typed.referToSelf(). Some repeated batterns of boilerpolate
signatures within different divisions of functions (bitwise, relational,
trigonometry) were factored out into their own files and reused in several
of the individual functions.
* tests: Only require that derivative tests mention the proper node type
* refactor: remove typed.ignore
* chore: Update to typed-function 3.0
Also had to deal with new typing for `resolve()` in that it now accepts
strings and Matrices; added tests for the new possibilities for `resolve()`,
and eliminated empty comments from the Node representation of parsed
strings as they can't really be doing anyone any good and they are a pain
for testing.
Also updates the TypeScript declarations and tests for `resolve()`
* chore: Object.hasOwn not supported in Node 14
Also removes 'resolve' from the known failing doc tests, now that it handles
strings.
* chore: Drop ES5 / IE 11 support.
* fix(types): Remove no-longer-implementd matrix overloads
* test(identifier): As requested in review item 2
* refactor(Unit): valType => valueType as per review item 3
* test(hasNumericValue): Test boolean arguments as per review item 4
* refactor(Node): Use class syntax rather than assigning prototypes
This change simplifies the typeOf() function, because now all subclasses
of Node have the expected constructor name.
Also, reformats the documentation of the typeOf() function so that the
doc test of that function will serve as an exhaustive test that the bundle
returns the proper types.
* Prevent chain functions from matching stored value with a rest parameter (#2559)
* chore: Prevent confusion with standard matrix functions. (#2465)
* chore: Prevent consfusion with standard matrix functions.
Prior to this commit, many functions operated elementwise on matrices
even though in standard mathematical usage they have a different
meaning on square matrices. Since the elementwise operation is easily
recoverable using `math.map`, this commit removes the elementwise
operation on arrays and matrices from these functions.
Affected functions include all trigonometric functions, exp, log, gamma,
square, sqrt, cube, and cbrt.
Resolves#2440.
* chore(typescript): Revise usages in light of changes
sqrt() is now correctly typed as `number | Complex` and so must
be explicitly cast to number when called on a positive and used
where a Complex is disallowed; sqrt() no longer applies to matrices
at all.
* feat: Provide better error messages for v10 -> v11 transition
Uses new `typed.onMismatch` handler so that matrix calls that used to
work will suggest a replacement.
* fix: prevent chain from matching rest parameter with stored value
Since the revised code needs the isTypedFunction predicate, switch to using
the typed-function implementation for that throughout mathjs, rather than
rolling our own here.
Also adds a test that chain() no longer allows this kind of usage.
Removes the two type declarations in types/index.d.ts that were allowing
this sort of "split rest" call and added tests that such calls are
forbidden.
Adds to the chaining documentation page that such "split" calls are not
allowed.
* chore: Refresh this PR to reflect underlying changes
Also addresses the review request with a detailed comment on the
correctness of a new code section.
Note that it reverts some changes to the TypeScript signatures of the
matrix functions ones() and zeros() -- they do not actually have a
typed-function signature of two numbers and an optional format
specifically for two dimensions. What they have is a single rest
parameter, from which the format is extracted if present.
Hence, due to the ban on breaking rest parameters, it is not
valid to call math.chain(3).zeros(2) to make a 3-by-2 matrix of zeros,
which seems like a perfectly valid ban as the division of the dimensions
is very confusing; this should be written as math.chain([3,2]).zeros().
The TypeScript signatures are fixed accordingly, along with the edge
case of no arguments to ones() and zeros() at all, which does work to
produce the "empty matrix".
* Unit test `typeOf` on the minified bundle (currently failing)
* Update AUTHORS
* Improve testing of typeOf on browser bundle (WIP)
* fix#2621: Module "mathjs" has no exported member "count" .ts(2305) (#2622)
* fix#2621: Module "mathjs" has no exported member "count" .ts(2305)
* feat: Update comments of count
* feat: update the signature for count
* feat: add usage example for count and sum
* chore: Ensure type info remains in bundling
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Co-authored-by: Chris Chudzicki <christopher.chudzicki@gmail.com>
Co-authored-by: Hansuku <1556207795@qq.com>
* Fix#46
Draft Implementations
* Add docs
* Fixup
* Add type declaration and test
* Fixup tests
* Fixup test
* Format
* Add examples in docs
* Update fft.js
Edit example in docs (`math.fft` returns complex matrix).
* Update ifft.js
Edit example in docs (`math.ffti` returns complex matrix).
* Update fft.js
Edit docs examples, representation of complex number from `a+bi` to `{re:a, im:b}`
* Update ifft.js
Edit docs examples, representation of complex number from `a+bi` to `{re:a, im:b}`
* Update index.ts
Edit test.
Add test for `math.ifft`
`math.fft` returns complex matrix.
* Update index.ts
Use `approx.deepEqual` instead off `assert.deepStrictEqual`.
* Update index.ts
Format code
* Update index.ts
Use `assert.ok(math.deepEqual(...))` instead of `approx.deepEqual`.
* Update index.ts
Format
* Update index.ts
Typo: replace `approx` with `assert`.
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
* 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
* Fix#2532: matrix index symbol `end` not working when used inside a sub-expression
* Refactor IndexNode.prototype._compile: remove redundant logic
* Throw a runtime exception when the context of an IndexNode is not a Matrix, Array, or string
* Describe the behavior of variable `end` nested indices
* Oopsie, fix linting issues
* Add a unit test to validate that `end` resolves to the inner context in case of nested indices
This is a sequel to #2531. Uniformizes the signatures of ceil, fix, floor,
and round, and updates the TypeScript declarations to match. Adds the
optional "number of places" argument to the chain versions of ceil, fix,
and floor. Adds TypeScript tests for all rounding functions.
Also corrects the TypeScript declaration for `bignumber()` and introduces
a couple more common abbreviations for TypeScript types.
Fixes the number-only implementations of floor, ceil, fix, and nthRoot
to match the full implementation behavior on numbers, and tests this for
floor.
Includes some minor documentation updates and additional unit tests for
the rounding functions.
Reverts inclusion in AUTHORS of incorrect email for one contributor,
that occurred in #2531.
Resolves#2526.
Resolves#2529.
* Optimize `det`
Use Bareiss algorithm.
The performance is preserved but lessen the round-off errors.
* Optimize `det`
Use index mapping instead of swapping the rows directly.
Run the benchmark to compare the performance.
* Edit test file
Replace `approx.equal` with `assert.strictEqual`.
The test will fail with the previously implemented LU decomposition.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
* fix(combinatorics): Improve precision of stirlingS2
Previously the computation of stirlingS2 used the closed form, which
suffers numerically by dividing a sum of very large terms by a large
factorial, causing roundoff errors for unnecessarily small inputs.
This commit switches to using the recurrence relation for the stirling
numbers of the second kind, and caching the partial results for future
calls. This has the advantage that all intermediate results are smaller
than the final value.
Also adds tests for much larger values of the stirlingS2 function and of
bellNumbers, whose computation depends on stirlingS2.
Resolves#2508.
* fix(stirlingS2): Correct lint errors.
Incorporating unit offsets into the internal "value" of the unit
causes more problems than it solves. This commit ends that practice
and instead only uses the offset when converting units or when
computing the absolute value of a unit.
Further, it makes it an error to compute the sign of a unit with an
offset, since that is inherently ambiguous: there is no way to tell
whether "-5 degC" is a temperature change, in which case it is definitely
negative, or if it is a specific temperature of something, in which case
it is "positive" in the sense of being above absolute zero.
(Unclear how valuable this latter concept is anyway, given that there are
no negative temperatures possible in that sense...)
Adds several tests for the various problems the former practice caused,
including all four basic arithmetic operations on units with offsets.
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
Also adds tests for math.log() of complex numbers in which the imaginary
part is much larger in absolute value than the real part.
Resolves#2503.
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
fix(approx): Make `approx.deepEqual` respect tolerance argument
Tests already contained calls of the form
`approx.deepEqual(A, B, epsilon)` but the comparison tolerance
argument epsilon was being silently ignored. This commit fixes
that oversight and corrects a couple of tests to reflect the finer-
grained testing.
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
* fix(FunctionNode): Improve error message when a non-function is called
Also adds tests for as many different varieties of function calls
and their associate messages when the entity being called is not
a function as I could come up with.
Resolves#2493.
* feat(format): Add a truncate option to limit result length.
Also uses the new option in FunctionNode.js to limit the length of the value
portion of its new error messages. (As requested in review)
* docs: Add 'truncate' option to the list in the exported version of 'format'
Also adds the test case that revealed the problem and corrects the other test
case that could have found it except the tolerance had been cranked up very
high.
Resolves#2478.
* test: Add unit tests for all of the examples in (jsdoc) comments
Uses the existing extraction of examples from tools/docgenerator.js
Hence, for now this is limited to documentation of functions, but
hopefully it can be extended to classes, units (and physical constants),
and constants as well in the future.
Exposes numerous errors in the examples, some of which are bugs; these
are for now put on a known error list to be worked on, so that this
PR does not change a huge number of source files.
Also adds a test to check that all symbols are documented (which
similarly doesn't really pass at the moment, and is patched to a
hopefully temporary warning).
* refactor: Make doc.test.js into a node test
The source code is not available in its layout as in the repository in
the browser tests, so the new doc testing can only occur in the node tests
* Add simplifyCore, symbolicEqual, map, and resolve to the list with functions with known issues in the jsdoc examples
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
Resolves#2427.
Also adds tests verifying that creating a fraction from two numbers
requires them both to be integers, and slightly updates documentation.
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
Resolves#1633
Co-authored-by: Hjortur Jonasson <hjorturjonasson@gmail.com>
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
* doc(map): Clarify the arguments to the callback
Also make the message when there is a type mismatch more detailed.
Resolves#2436.
* test(map): Add tests relevant to new documentation
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
This change fixes a typing problem in complexEigs.js in which
real-valued norms were inadvertently being typed as complex numbers.
Resolves#2439
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
* feat(FunctionNode): allow function parameters to be called
This change is implemented by checking if a function symbol is in
the arg list, and if so delaying its analysis until evaluation time,
at which point it is extracted from the arguments and called as
appropriate depending on its rawArgs property.
Also adds a few tests, documents the new facility, and documents the
handling of free variables in a function definition, which was previously
left undescribed.
Resolves#2441.
Resolves#2442.
* chore: correct lint violations (sorry)
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
* 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>
* 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>
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.
Prior to this change, combinations(42,21) did not return an integer,
despite its value being well below MAX_SAFE_INTEGER. Now the
multiplications and divisions are balanced to try to keep the
intermediate results within the safe range.
Adds a couple of tests for larger values of combinations().
Resolves#2413.
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
* 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>
