114 Commits

Author SHA1 Message Date
Jos de Jong
391677f9e0 fix #2888: update type definitions of function unit to allow creating a unit from a fraction or complex number 2023-02-02 10:32:06 +01:00
brunoSnoww
654e1b7357
Refactor dotMultiply, dotPow and dotDivide types (#2890)
* refactor types

* refactor on chain types

---------

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2023-01-31 17:21:36 +01:00
Jay Wang
78a593bbb5
Change types in matrix map() and forEach() (#2887)
* Change types in matrix map() and forEach()

* Add new line in the end of index.d.ts

Signed-off-by: Jay Wang <xiao.hk1997@gmail.com>

---------

Signed-off-by: Jay Wang <xiao.hk1997@gmail.com>
2023-01-31 17:15:22 +01:00
Ari Markowitz
ac0ffb7d15
Add numeric types to complex() type declaration (#2886) 2023-01-30 11:31:13 +01:00
Jos de Jong
c7160589b7 fix linting issue of #2864 2023-01-06 11:28:08 +01:00
Evan Miller
cb5a4e9743 lint 2023-01-05 09:07:03 -05:00
Evan Miller
17cfd8b944 Add type signature for lusolve(LUDecomposition, ...) 2023-01-04 14:00:54 -05:00
brunoSnoww
0c6e832ab7
Fix: Add "rotationMatrix" function type (#2860)
* fix: add rotation matrix type

* remove mistaken test

* code-review: refactor type and add tests for it
2022-12-09 16:33:58 +01:00
Jos de Jong
eb9b56db88 Publish v11.5.0, update devDependencies, fix linting issue 2022-12-05 10:54:14 +01:00
Henry Chan
360ce0125b
Fix correct types for multiply() (#2852)
Fix correct types for `multiply( number[][], number[] )`, `multiply( number[], number[][] )` and `multiply( number[][], number[][] )`

Type errors were introduced with https://github.com/josdejong/mathjs/pull/2623/files which used MathArray directly (where MathArray could be number[] or number[][]), causing the return type to be number[] | number[][].

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-12-05 10:46:30 +01:00
Glen Whitney
f6d3e9ea8d
feat: add polynomialRoot function (#2839)
* feat: add polynomialRoot function

  This is intended as a benchmark for general arithmetic/basic algebra
  functionality of mathjs, but was chosen to be something of potential
  independent utility as well, worth adding to mathjs in its own right.

  Currently ol=nly computes the numerical roots for real or complex
  polynomials of degree three or less.

  As usual, adds documentation, embedded documentation, tests, TypeScript
  declaration, and TypeScript tests.

  Also updates doc.test.js to make it easier to specify an array of complex
  numbers as the expected output, and comapres with the appropriate fuzz
  in such cases.

  Finally, adds a benchmark that computes the roots of all cubics with
  nonnegative integer coefficients no larger than five.

* doc: fix typo in polynomialRoot embedded docs

Thanks, SamuelTLG

* style: avoid slightly cryptic Boolean flag stand-in
2022-11-18 15:53:45 +01:00
Jos de Jong
b050d5ed5d Fix the docs and types of forEach, which returns void (see #2840) 2022-11-18 10:18:59 +01:00
Lucas Egidio
a2e85ca698
Added functions: schur, sylvester, and lyap (#2646)
* Added matrix functions `schur`, `sylvester` and  `lyap`

* Added docs for  `schur`, `sylvester` and  `lyap`

* Added unit tests for  `schur`, `sylvester` and  `lyap`

* Fixed lint and tests errors

* fixed typescript and added Matrix + Array tests

* lint fixed

* fixed example in sylvester.js doc

* Fixed docs and ci

* fixed definition of lyap and sylvester

* remark on diff defs for lyap

* rm a trailing space

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-11-17 17:16:21 +01:00
Jos de Jong
b9678ca029 Fix #2840: a bug in the type definition of Node.traverse, and update history 2022-11-16 09:21:19 +01:00
Jos de Jong
0a810abba3 Fix a regression in the type definitions of FunctionNode, introduced in v11.3.2. See #2733 2022-11-07 10:09:16 +01:00
Matt Vague
f79517f166
Types/add generics to remaining node types (#2733)
* Add generic args for FunctionNode

* Add generic args for AccessorNode

* Add generic args for ArrayNode

* Add generic args for AssignmentNode

* Add generic args for BlockNode

* Add generic args for ConditionalNode

* Add generic args for ConstantNode

* Add generic args for FunctionAssignmentNode

* Add generic args for IndexNode

* Add generic args for ObjectNode

* Add generic args for RangeNode

* Add generic args for RelationalNode

* Change default constant node type to number
2022-10-20 09:18:05 +02:00
Jos de Jong
9ca8f2d2ad Fix type definition reported in #2609 2022-10-19 15:10:21 +02:00
Jos de Jong
5e439be0a8
Fix #2809: code completion issues in some IDE's (#2812)
* Move types/index.ts to test/typescript-tests/testTypes.ts (WIP)

* Fix the paths for the test:types script

* Move tsconfig.json to the root
2022-10-19 08:23:14 +02:00
BOUYA Med. Salim
c6883db0d3
fix #2603: added type definition for onUndefinedSymbol & onUndefinedFunction (#2610)
* fix #2603: added type definition for SymbolNode.onUndefinedSymbol and FuctionNode.onUndefinedFunction

* fix return type of onUndefinedFunction

* fix return type of onUndefinedFunction

* fix onUndefinedSymbol & onUndefinedFunction types, added examples

* update onUndefinedFunction ts example
2022-10-18 10:42:50 +02:00
Hanchai Nonprasart
822ea2a1c7
fix(pinv): write a typescript definition and test (#2804)
* fix(pinv): write a typescript definition

* fix(pinv): write a typescript test

* fix(pinv): format types/index.ts

* fix(pinv): format types/index.ts

* fix(pinv): format types/index.d.ts

* fix(pinv): format types/index.ts

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-10-11 11:14:58 +02:00
Matt Vague
2294ebded7 Switch MathNode and MathNodeCommon 2022-09-12 12:29:42 -07:00
Matt Vague
8e116a36f1 Fix target 2022-09-12 12:26:31 -07:00
Matt Vague
2de83dde17 Fix specs 2022-09-12 12:26:16 -07:00
Matt Vague
2c4dd5e88e Make it possible to extend base Node type without typescript being angry 2022-09-12 12:26:15 -07:00
Jos de Jong
194725727a Fix type definition and TS example of chained pickRandom (see #2770) 2022-09-09 14:37:57 +02:00
Jos de Jong
00f3e485ef Fix linting issues 2022-09-09 12:51:18 +02:00
Matt Vague
fcabc9722b Whoops change types to how mathjs actually works 2022-09-08 17:46:48 -07:00
Matt Vague
be97efa9a0 Add pickRandom types for chain too 2022-09-08 17:43:15 -07:00
Matt Vague
546d03c427 Add examples for pickRandom types 2022-09-07 10:14:58 -07:00
Matt Vague
b2e83e6bd7 Fix types for pickRandom
The TS type for pickRandom currently restricts the given array to numbers, however (AFAIK) it doesn't actually care what the array given to it contains.

This PR:
- Uses a generic to type the given array
- Varies the return type (T or T[]) depending on the given args
2022-09-06 19:14:48 -07:00
Abdullah Adeel
dbfce94f7a
🔧 fixed typos in min func type defs (#2768) 2022-09-06 14:36:39 +02:00
Jos de Jong
4e58ccc666 Merge branch 'utils/add-is-relational-node-function' of github.com:goodproblems/mathjs into goodproblems-utils/add-is-relational-node-function 2022-09-02 16:24:41 +02:00
Isaac B
f4f44a84aa Rebased with main 2022-08-30 17:12:22 -07:00
Isaac B
6e6f726a2f Update test and definitions 2022-08-30 17:10:27 -07:00
Ajinkya Chikhale
5649892952
Added missing types 'largerEq' and 'or' in OperatorNodeMap (#2681) 2022-08-30 17:34:05 +02:00
Isaac B
b990bd2be4
Merge branch 'develop' into utils/add-is-relational-node-function 2022-08-29 10:15:35 -07:00
Isaac B
47a12807d4 Add isRelationalNode function 2022-08-29 10:13:48 -07:00
Matt Vague
f334bad9bd
Add replacer to index.d.ts (#2687) 2022-08-23 16:38:02 +02:00
Glen Whitney
19b4eac98a
test(TypeScript): Enhance test to compile as well as run. (#2634)
Resolves #2633.
2022-07-27 15:34:58 +02:00
Jos de Jong
1464c2e15d Publish v11.0.1, fix linting issues 2022-07-25 10:02:52 +02:00
Jos de Jong
7794e1c3fa Fix some issues in index.ts 2022-07-25 09:47:11 +02:00
Jos de Jong
cd1ccdba6d Fix #2632: incomplete type definitions for simplifyConstant and simplifyCore 2022-07-25 09:37:35 +02:00
Jos de Jong
7a38dc004b Publish v11.0.0 2022-07-23 12:12:56 +02:00
Windrill
1bd7ade59c
matrix*vector multiplication returns a vector (TS) (#2623)
* vector*matrix multiplication returns a vector

* in multiply, matrix has precedence and have specific case for js arrays which is distinct from matrix

* add test examples

* type distinguishing javascript function

* linter style
2022-07-22 09:25:09 +02:00
Jos de Jong
59320053fd
V11 with typed-function@3 (#2560)
* 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>
2022-07-19 12:04:35 +02:00
BOUYA Med. Salim
ba611c4ac0
fix #2607: improve type definition for createUnit (#2609)
* fix #2607: improve type definition for createUnit

* added usage example of createUnit
2022-07-01 15:36:24 +02:00
Laureen Beaudry
517dc58909
Add missing types for simplify rules (#2601)
* Add missing types for simplify rules

* Add more simplify type tests

Co-authored-by: Matt Vague <mattvague@gmail.com>
2022-07-01 13:46:51 +02:00
Matt Vague
6bdc8b84e5
Types/improve factory dependencies (#2605)
* Fix NodeCtor

* Improve types for factory function

Dependencies available in factory callback are now dependent on list of dependencies which are passed in
2022-06-28 09:47:29 +02:00
Jos de Jong
f3cf2d42fe Revert "Improve types for factory function (#2592)"
This reverts commit 3a59a768c39f65f5243e8fc3bd5ac80a4df1a270.
2022-06-24 22:06:42 +02:00
Matt Vague
3a59a768c3
Improve types for factory function (#2592)
* Improve types for factory function

Dependencies available in factory callback are now dependent on list of dependencies which are passed in

* Add Node to dependencies

* Format
2022-06-24 11:37:33 +02:00