124 Commits

Author SHA1 Message Date
Orel Ben Neriah
b81420fad6
chore: update matrix documentation to align with v15 (#3591)
Resolves #3565.

---------
Co-authored-by: Glen Whitney <glen@studioinfinity.org>
2025-11-11 15:07:16 -08:00
Jos de Jong
302ed812e1
fix: #3529 change function size to always return an Array (#3535) 2025-10-09 10:33:15 +02:00
Jos de Jong
1e3c2a99aa Merge branch 'develop' into v15
# Conflicts:
#	HISTORY.md
2025-09-24 11:25:19 +02:00
Jos de Jong
a8ec24d595 docs: some updates in the description to migrate matrix index behavior to v15 (see #3485) 2025-07-16 10:58:25 +02:00
David Contreras
10602fdbfd
feat: matrix subset according to type of input (#3485) 2025-07-16 10:40:13 +02:00
Jacopo Mercolini
8d19c8b51e
feat: toBest(unit, unitList, offset) function (#3484)
* feat: toBest tests

* feat: toBest function initial

* fix: tests and function changes

* fix: dependencies

* new way to handle

* updated tests

* test updated

* tests fixed

* cleaned useless tests

* cleaned useless condition

* fix: missing comments

* fix: moved tests

* other fix and clean

* change test to work with npx mocha "path" -g "toBest"

* deleted check large and small value

* deleted precision test and fix options to bestprefix

* fix: moved toBest tests in correct file

* fix: math create

* fix: aligned files pre-mr

* fix: toBest docs test

* fix: lint issues

* fix: comments

* fix: added a helper function to simplify the test readability

* fix: unit.md and units.md docs updated

* fix: test on units.length

* added post process denormalize for tobest function to string returned value

* removed this.clone into format

* feat improve incompatible units test

* fix assign prefixes

* fixed examples

* changed order of params of assertUnit

* fixed comments and added toBest in knowProblems at doc.test

* refactor: update toBest functionality and adjust related tests for accuracy

* refactor: remove unnecessary offset initialization in prefix application

---------

Co-authored-by: Luca Quercetti <l.quercetti@wecodeyou.it>
Co-authored-by: Elia Alesiani <elia.alesiani@gmail.com>
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
Co-authored-by: lucaQ <lucaquercetti@gmail.com>
Co-authored-by: EliaAlesiani <105418798+EliaAlesiani@users.noreply.github.com>
2025-07-09 19:16:47 +02:00
Jos de Jong
de7865c69a docs: fix broken examples on the "Data types" page 2025-05-21 17:38:18 +02:00
David Contreras
bcf0da46f0
feat: support multiple inputs in function map (#3228) 2024-08-22 13:35:21 +02:00
Jos de Jong
ab3461d484
feat: implement support for bigint (#3207, #2737) 2024-05-31 12:43:09 +02:00
David Contreras
eded7e1dc3
feat: nearly equal with relative and absolute tolerance (#3152)
* nearlyEqual with absolute and relative tolerances

* Format

* nearlyEqual for bigNumber

* Added skip for NaN

* Reduce diff a bit

* Issue with examples in jsdcos

* Updated all calls for nearlyEqual

* Fixed failing tests

* Changed epsilon to relTol, absTol

* Changed references to epsilon in docs and tests

* Added warning for config.epsilon

* Fix warning in zeta.test

* Added config test

* Added sinon to test console.warn

---------

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2024-05-15 10:56:11 +02:00
Jos de Jong
085b85532c docs: fix broken example in the documentation about matrices (see #3159) 2024-02-16 15:48:12 +01:00
Alex Edgcomb
af55b125a2
Support new metric prefixes: Q, R, r, and q (#3113)
* added Q, R, r, q metrix prefixes

* tests added for new prefixes

* removed duplicate tests

* maybe square and cubic tests will bump code cov into the positive

* Check numeric value

---------

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2024-01-10 17:29:52 +01:00
Jos de Jong
a8cc5f9ae5 docs: update links to https://github.com/rawify/Fraction.js 2023-09-04 15:48:35 +02:00
David Contreras
49c793ba5a
feat: Indexing with an array of booleans (#2994)
* Included math to syntax when missing

* Included solveODE

* renamed initialStep as firstStep

* Included tests for solveODE

* Test the full state instead of the final state

* Fixed issue with tolerance

* Indexing with an array of booleans

* Indexing with booleans and with empty

* Changed index embedded docs

* removed solveODE

* typos on tests

* included config.predictable

* Throws an error if the size doesn't match

* Included config predictable to get subset

* Can do replacement by broadcasting

* DenseMatrix set can broadcast first

* Added tests for broadcasted subset in the parser

* Faster cloning of deep arrays

* Included docs and better test coverage

* Test coverage for `subset`

* Removed config predictable from subset

* Removed config from index and sparseMatrix

* Redaction and typos

* Cleanup unnecesary changes

* fixed issue when there is no need to broadcast

* Inline ifs

* Included specific broadcasting test

* Reduced repetition

---------

Co-authored-by: David Contreras <david.contreras@guentner.com>
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2023-07-28 09:30:04 +02:00
David Contreras
ebf92874e2
d was assigned twice to a constant (#2930) 2023-04-21 16:42:03 +02:00
Jos de Jong
db3e62e5c3
feat: extend functions fraction, bignumber, and number with support for units, see #2918 (#2926)
* feat: extend function `fraction` with support for units (see #2918)

* fix: update the TypeScript definitions with the new `math.fraction(value: Unit)` support

* feat: implement `math.bignumber(value: Unit)`

* feat: update type definitions of function `math.bignumber`

* fix: linting issue

* feat: implement support for `math.number(unit)` (was formerly throwing an exception)
2023-04-03 13:48:24 +02:00
Jos de Jong
151baca0af fix #2908: improve docs and examples of functions partitionSelect, diff, expm1, round, nthRoots, sign, rigthArithShift, setIsSubset, setSize, and the docs about units 2023-03-09 11:54:45 +01:00
Jos de Jong
6fb485de5f fix #2906: improve description of the behavior of subset for scalar values in the docs 2023-02-27 11:28:22 +01:00
David Contreras
f8013cc99a
Broadcasting (#2895)
* broadcasting

* Simplified broadcasting

* Updated for broadcasting

* Changed to camel case

* Camel case and auto formating

* Added comments

* Skip if matrices have the same size

* Fixed issue with undefined variable

missing dot  in `A._size`

* Implemented broadcasting in all functions

* Added helper functions

* Added function to check for broadcasting rules

* Tests for broadcasted arithmetic

* Fixed issue with matrix the size of a vector

* Documented and updated broadcasting

* Included broadcast.test

---------

Co-authored-by: David Contreras <david.contreras@guentner.com>
Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2023-02-23 19:24:55 +01:00
Jos de Jong
0230a17af5 Fix: split a long sentence in the docs in two 2023-02-08 11:52:29 +01:00
Jos de Jong
edb8b5ffd1 Fix: typo in the docs about calculations with matrices 2023-02-08 11:49:35 +01:00
Jos de Jong
5278a05328 docs: fix description and examples of element-wise matrix calculations (see #2440) 2023-01-13 14:33:10 +01:00
Jason Hornsby
34292280ec
Fix min as short for minim not minute in documentation (#2773)
Co-authored-by: Jason Hornsby <jason.hornsby@scale.eu>
2022-09-12 15:48:44 +02:00
Carl Osterwisch
7de574a556
Unit from Unit (#2628)
* 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>
2022-07-26 07:29:31 -07: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
Jos de Jong
f9b944acfe Fix #2613: describe matrix methods get and set in the docs and example 2022-07-04 09:51:09 +02:00
Jos de Jong
297d2e0c55 Fix: #2608: describe changing epsilon when configuring BigNumber. 2022-06-29 10:39:02 +02: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
David Contreras
c9f88f7d3c
Fixed a formula and changed R to degR (#2498)
Changed `R` to `degR` as there is no unit `R`

`math.createUnit('mile', '1609.347218694', {override: true}})` has a syntax error (an extra `{` ) and is missing units, changed it to `math.createUnit(('mile', '1609.347218694 m', {override: true})` as I think was the original intention.

Co-authored-by: Jos de Jong <wjosdejong@gmail.com>
2022-03-25 16:35:09 +01:00
Jos de Jong
06052ecc86 Fix #2142: clarify the meaning of matrix dimensions in the docs 2021-04-05 14:44:50 +02:00
rnd-debug
a34ebc2478
Providing overridable Unit.isValidAlpha (#2000)
* first commit

* providing some tests

* some docs
2020-10-28 11:50:45 +01:00
Jos de Jong
9e462268e5 Fix #1940: error in the documentation about resizing matrices 2020-08-10 21:49:40 +02:00
Eric Mansfield
97ff95b32c Added baseName option to createUnit (#1708)
* Fixed unit base recognition and formatting for user-defined units

* Added baseName option to createUnit

* Trailing spaces

* Fixed line in docs
2020-01-08 10:23:23 +01:00
jos
718b93b2b4 Create unit aliases bit and byte 2019-08-28 15:41:39 +02:00
jos
6081360d6a Merged develop into modular_architecture 2019-04-13 16:51:51 +02:00
jos
70cbc3ec30 Replace http urls with https where supported 2019-02-27 13:08:42 +01:00
jos
99da53da0e Flatten everything in a mathjs instance to make it consistent with the ES6 exports. Create deprecation warnings for the old classes and functions 2019-02-07 21:24:51 +01:00
jos
078f1dd69f Renamed methods .eval to .evaluate, updated all docs and examples accordingly 2019-01-16 10:11:32 +01:00
jos
f6b524a966 Use object destructuring in factory function callback. Rename typeof to typeOf. Only pass dependencies in scope to factory function. 2018-11-06 09:17:21 +01:00
jos
d4543e2212 Fixed docs mentioning wrong default value of epsilon 2018-07-11 08:54:07 +02:00
Daniel Kostro
0fab3e1523
fix format link in units page 2018-07-07 09:58:47 +02:00
jos
8b5eb89a02 Minor tweaks in the docs 2018-06-16 14:57:28 +02:00
ssaket
f06badd172 applied suggested changes on the docs 2018-06-14 21:22:35 +05:30
ssaket
9bf6a30332 fixed lint issues 2018-06-14 20:27:53 +05:30
ssaket
a5dcb02410 updated docs of complex numbers -issue:964 2018-06-14 18:47:13 +05:30
jos
b6b36bfd9b Use strict equality checks everywhere (=== and !==) 2018-06-13 15:02:21 +02:00
jos
b3b96749bf Refactored var into const/let, and removed a lot of semicolons 2018-06-13 12:21:14 +02:00
jos
cf5c1c1af8 Fixes #1054: renamed eye to identity 2018-06-06 10:52:08 +02:00
jos
99ab11b234 Dropped constant uninitialized 2018-02-04 13:09:09 +01:00
jos
51fdf560bf Updated history 2017-06-05 17:06:48 +02:00