76 Commits

Author SHA1 Message Date
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
Matt Vague
05388ce5a2
Make MathNodeCommon['type'] property a string (#2593)
This makes it possible to add custom data types
2022-06-13 11:51:26 +02:00
Matt Vague
5a21e4cdd2
Improve ParenthesisNode types (#2591)
* Improve ParenthesisNode types

* Format
2022-06-13 11:47:31 +02:00
Matt Vague
5989068921
Types/improve transform types (#2580)
* Add generic args to OperatorNode for `fn` and `op`

* Fix lint

* Properly type return value of `transform()`

* Lint
2022-06-09 15:54:25 +02:00
Matt Vague
cd33da8d16
Types/improve operator node types (#2576)
* Add generic args to OperatorNode for `fn` and `op`

* Fix lint

* Format and add generic for args as well

* Make OperatorNode generics optional using `never`
2022-05-31 11:41:32 +02:00
Matt Vague
2ab26e0cf4
Properly type return value of clone() and cloneDeep() (#2572)
* Properly type `clone` and `cloneDeep` return types

* Format
2022-05-24 17:20:55 +02:00
HanchaiN
ca3229fd7e
Feature: Implementation of fourier transform (#2540)
* 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>
2022-05-24 09:35:10 +02:00
Matt Vague
89d9b324df
Improve typing for MathJsChain (#2537)
* Make MathJsChain generic

* Start converting chain methods to overload `this`

* Properly type chain().bignumber()

* Split boolean type definition into separate overloads

* Add proper boolean chain definition

* Add proper complex chain definition

* Add proper createUnit chain definition

* Add proper createUnit chain definition

* Add proper index chain definition

* Add proper matrix chain definition

* Add proper number type definition

* Add proper sparse chain definition

* Add proper splitUnit chain definition

* Split string type definition into multiple overloads

* Add proper string chain definition

* Correct unit typings by splitting into multiple overloads

* Add proper unit chain definition

* Add proper compile chain definition

* Split evaluate type definition into multiple overloads

* Add proper evaluate chain definition

* Add proper parse chain definition

* Add proper parser chain definition

* Add proper resolve chain definition

* Add proper derivative chain definition

* Split lsolve type definition into multiple overloads

* Add proper lsolve chain definition

* Extract LUDecomposition type

* Add proper lup chain definition

* Remove incorrect number arg type and split lusolve into multiple overloads

* Remove unnecessary done checks

* Add proper lusolve chain definition

* Extract QRDecomposition type

* Add proper qr chain definition

* Add proper rationalize chain definition

* Add proper simplify chain definition

* Extract SLUDecomposition type

* Add proper slu chain definition

* Split usolve into multiple overloads

* Add proper usolve chain definition

* Add proper abs chain definition

* Add proper add chain definition

* Add proper apply chain definition

* Add proper cbrt chain definition

* Add proper ceil chain definition

* Add fix, floor, and round chain defs

* Add proper cube chain definition

* Add proper divide chain definition

* Add proper dot* chain definitions

* Add proper exp, expm1 chain definitions

* Add proper gcd chain definition

* Add proper hypot chain definition

* Add proper lcm chain definition

* Copy over remaining definitions and comment out

* Convert rest of chain fns

* Format

* Various fixes

* Fix lint

* Remove incorrect mathjs complex chain type

* Extract FractionDefinition type so that typescript doesn't confuse `object` with `MathCollection`

* Fix createUnit error

* Fix parser

* Remove parser from MathJsChain as it doesn't actually work...

Error "Uncaught TypeError: Too many arguments in function parser (expected: 0, actual: 1)" is thrown

* Fix apply test

* Remove fraction as acceptable value for cbrt

Doesn't actually work, throws "Cannot implicitly convert a Fraction to BigNumber or vice versa. Use function bignumber(x) to convert to BigNumber or fraction(x) to convert to Fraction."

* Fix unit

* Remove `Unit` as acceptable type for cbrt

Throws error: " Unexpected type of argument in function isNegative (expected: number or BigNumber or Fraction or Unit or Array or Matrix or string or boolean, actual: null, index: 0)"

* Fix more units

* Fix gcd chain types

* Format

* Improve lusolve type tests

* Make `add` chain type behave same as normal `add` type

* Improve `re` and `im` types and chain types

* Format

* Whoops

* Linty lint lint

* Fix lusolve tests

* Format
2022-05-24 09:21:06 +02:00
Jos de Jong
6d0f9ff28a Fix linting issues 2022-05-02 08:42:10 +02:00
Matt Vague
1bb2311d1e Fix test 2022-04-29 09:37:06 -07:00
Matt Vague
907a7db365 Lint 2022-04-29 09:32:09 -07:00
Matt Vague
72355e5b63 Newlines 2022-04-29 08:34:33 -07:00
Matt Vague
cd55c7233c Test chained cases too 2022-04-29 08:34:30 -07:00
Matt Vague
b78ae9cf62 Add resolve type test 2022-04-29 08:34:07 -07:00
Matt Vague
90bc776bcc Improve resolve type to support multiple nodes 2022-04-29 08:33:45 -07:00
Matt Vague
537f392fc3 Add TS type for resolve function 2022-04-29 08:33:45 -07:00
Jos de Jong
b9586ab33d Merge branch 'types/toTex-optional-options' of https://github.com/goodproblems/mathjs into goodproblems-types/toTex-optional-options
# Conflicts:
#	types/index.d.ts
#	types/index.ts
2022-04-29 12:19:10 +02: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
Matt Vague
e56cf85bc5 Reflect purpose of override option in tests 2022-04-26 08:48:06 -07:00
Matt Vague
49ca446390 Fix import tests 2022-04-26 08:20:31 -07:00
Matt Vague
e142bce4e2 Newline 2022-04-25 12:26:34 -07:00
Matt Vague
a76878c897 Consolidate math.import tests 2022-04-25 12:26:17 -07:00
Matt Vague
8a488f0705 More tests 2022-04-25 08:44:47 -07:00
Matt Vague
c0a8919a77
Merge branch 'develop' into types/toTex-optional-options 2022-04-25 08:41:42 -07:00
Matt Vague
b381677cdd Add type tests for import and toTex 2022-04-25 08:40:42 -07:00
Glen Whitney
82074e85e0
fix: Type declarations for rounding functions (#2539)
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.
2022-04-25 12:07:02 +02:00
Matt Vague
70c761249f Make import() options actually optional 2022-04-20 17:12:04 -07:00
simlaticak
45514a832e
Updated ceil types (#2531)
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-04-19 14:31:49 +02:00
yifanwww
b3f564f266
feat: Implement lgamma function -- log(gamma(z))) -- for number and Complex (#2417)
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
2022-04-11 20:00:16 -07:00
Chris Chudzicki
99839a8da3
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>
2022-03-17 16:17:32 -07:00
NattapongSiri
b8d2e81ee7
fix(TypeScript): Make dim argument optional for std and variance (#2474)
Also adds TypeScript test cases for these functions.

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-03-16 14:01:43 -07:00
Sinan
408094a7a4
Added unit(unit: Unit) TS overload (#2479)
* Added unit(unit: Unit) TS overload
2022-03-15 17:40:54 +01:00
Sam Estep
bb9eb4e0ec
Add checks for type declarations (#2448)
* Add overloads for Matrix add and subtract

* Add check for types/index.ts

* Fix type errors in types/index.ts

* Fix a couple execution errors

* Run test:types as part of test:all

* Fix remaining errors

* Replace types/index.ts comments with asserts

* Add tests for narrowed type inference

* Add dual-purpose comment at top of types/index.ts

* Update AUTHORS

* Use Glen's alternate test:types suggestion
2022-03-08 15:59:35 +01:00
Jos de Jong
c957d41053
Implement cumsum function for computing cumulative sums (#1870)
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>
2022-03-05 23:06:51 -08:00
NattapongSiri
145c540627
Fix std and variance type definition for #2429 (#2455)
* Fix std and variance type definition

* Fix JSDoc and add overload for var/std of chain

* Fix array type and remove duplicate norm type

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-03-04 11:03:07 +01:00
Josh Hansen
89bcd4776f
Reflect simplifyCore relocation in Typescript (#2456) 2022-03-02 08:32:05 +01:00
Glen Whitney
dd1d08a175
docs(subset): Improve documentation of indices (#2446)
Incorporates (and supersedes) #2326 and the discussion therein.
  Resolves #2325.

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-03-01 14:36:42 +01:00
yifanwww
15c4254bc9
feat: Make gamma generic (#2416)
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-02-28 09:15:25 +01:00
Josh Hansen
1b34c580f6
fix(types): Unit Typescript type update (#2450)
Add missing BigNumber parameter type to `math.unit` and add types for Unit.simplify and Unit.units
  Resolves #2353.
2022-02-27 23:45:47 -08:00