mathjs/src/expression/embeddedDocs/function/matrix/diff.js

Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif

export const diffDocs = {
  name: 'diff',
  category: 'Matrix',
  syntax: [
    'diff(arr)',
    'diff(arr, dim)'
  ],
  description: [
    'Create a new matrix or array with the difference of the passed matrix or array.',
    'Dim parameter is optional and used to indicant the dimension of the array/matrix to apply the difference',
    'If no dimension parameter is passed it is assumed as dimension 0',
    'Dimension is zero-based in javascript and one-based in the parser',
    'Arrays must be \'rectangular\' meaning arrays like [1, 2]',
    'If something is passed as a matrix it will be returned as a matrix but other than that all matrices are converted to arrays'
  ],
  examples: [
    'diff([1, 2, 4, 7, 0])',
    'diff([1, 2, 4, 7, 0], 0)',
    'diff(matrix([1, 2, 4, 7, 0]))',
    'diff([[1, 2], [3, 4]])',
    'diff([[1, 2], [3, 4]], 0)',
    'diff([[1, 2], [3, 4]], 1)',
    'diff([[1, 2], [3, 4]], bignumber(1))',
    'diff(matrix([[1, 2], [3, 4]]), 1)',
    'diff([[1, 2], matrix([3, 4])], 1)'

  ],
  seealso: ['subtract', 'partitionSelect']
}