Merge remote-tracking branch 'origin/develop' into develop

Author: josdejong

src/utils/optimizeCallback.js

@@ -8,10 +8,10 @@ import { typeOf as _typeOf } from './is.js'
  * @param {Function} callback The original callback function to simplify.
  * @param {Array|Matrix} array The array that will be used with the callback function.
  * @param {string} name The name of the function that is using the callback.
- * @param {boolean} [isUnary=false] If true, the callback function is unary and will be optimized as such.
+ * @param {boolean} isUnary If true, the callback function is unary and will be optimized as such.
  * @returns {Function} Returns a simplified version of the callback function.
  */
-export function optimizeCallback (callback, array, name, isUnary = false) {
+export function optimizeCallback (callback, array, name, isUnary) {
   if (typed.isTypedFunction(callback)) {
     let numberOfArguments
     if (isUnary) {

test/unit-tests/function/matrix/ctranspose.test.js

@@ -18,7 +18,7 @@ describe('ctranspose', function () {
     assert.deepStrictEqual(ctranspose(math.matrix([1, 2, 3]).toArray()), [1, 2, 3])
   })
 
-  it('should conjgate a complex vector', function () {
+  it('should conjugate a complex vector', function () {
     const a = math.complex(1, 2)
     const b = math.complex(3, 4)
     const c = math.complex(5, 6)

types/index.d.ts

@@ -1093,7 +1093,7 @@ export interface MathJsInstance extends MathJsFactory {
    * decomposition.
    * @param order The Symbolic Ordering and Analysis order: 0 - Natural
    * ordering, no permutation vector q is returned 1 - Matrix must be
-   * square, symbolic ordering and analisis is performed on M = A + A' 2 -
+   * square, symbolic ordering and analysis is performed on M = A + A' 2 -
    * Symbolic ordering and analysis is performed on M = A' * A. Dense
    * columns from A' are dropped, A recreated from A'. This is appropriate
    * for LU factorization of non-symmetric matrices. 3 - Symbolic ordering
@@ -1329,7 +1329,7 @@ export interface MathJsInstance extends MathJsFactory {
    * @param args A list with numeric values or an Array or Matrix. Matrix
    * and Array input is flattened and returns a single number for the
    * whole matrix.
-   * @returns Returns the hypothenuse of the input values.
+   * @returns Returns the hypotenuse of the input values.
    */
   hypot<T extends number | BigNumber>(...args: T[]): T
   hypot<T extends number | BigNumber>(args: T[]): T
@@ -1547,7 +1547,7 @@ export interface MathJsInstance extends MathJsFactory {
    * strings will be converted to a number. For complex numbers, both real
    * and complex value are inverted.
    * @param x Number to be inverted
-   * @returns Retursn the value with inverted sign
+   * @returns Returns the value with inverted sign
    */
   unaryMinus<T extends MathType>(x: T): T
 
@@ -1758,7 +1758,7 @@ export interface MathJsInstance extends MathJsFactory {
    ************************************************************************/
 
   /**
-   * Calculates: The eucledian distance between two points in 2 and 3
+   * Calculates: The Euclidean distance between two points in 2 and 3
    * dimensional spaces. Distance between point and a line in 2 and 3
    * dimensional spaces. Pairwise distance between a set of 2D or 3D
    * points NOTE: When substituting coefficients of a line(a, b and c),
@@ -1898,6 +1898,14 @@ export interface MathJsInstance extends MathJsFactory {
    */
   cross(x: MathCollection, y: MathCollection): MathCollection
 
+  /**
+   * Transpose and complex conjugate a matrix. All values of the matrix are
+   * reflected over its main diagonal and then the complex conjugate is taken.
+   * This is equivalent to complex conjugation for scalars and vectors.
+   * @param x Matrix to be ctransposed
+   */
+  ctranspose(x: MathCollection): MathCollection
+
   /**
    * Calculate the determinant of a matrix.
    * @param x A Matrix
@@ -2082,7 +2090,7 @@ export interface MathJsInstance extends MathJsFactory {
 
   /**
    * Calculate the inverse of a square matrix.
-   * @param x Matrix to be inversed
+   * @param x Matrix to be inverted
    * @returns The inverse of x
    */
   inv<T extends number | Complex | MathCollection>(x: T): NoLiteralType<T>
@@ -2191,7 +2199,7 @@ export interface MathJsInstance extends MathJsFactory {
 
   /**
    * Calculate the Moore–Penrose inverse of a matrix.
-   * @param x Matrix to be inversed
+   * @param x Matrix to be inverted
    * @return The inverse of `x`.
    */
   pinv<T extends MathType>(x: T): T
@@ -2458,7 +2466,7 @@ export interface MathJsInstance extends MathJsFactory {
    * distributions
    * @param q First vector
    * @param p Second vector
-   * @returns Returns disance between q and p
+   * @returns Returns distance between q and p
    */
   kldivergence(q: MathCollection, p: MathCollection): number
 
@@ -2475,7 +2483,7 @@ export interface MathJsInstance extends MathJsFactory {
    * takes one array of integers as an argument. The following condition
    * must be enforced: every ai <= 0
    * @param a Integer number of objects in the subset
-   * @returns multinomial coefficent
+   * @returns multinomial coefficient
    */
   multinomial<T extends number | BigNumber>(a: T[]): NoLiteralType<T>
 
@@ -2580,7 +2588,7 @@ export interface MathJsInstance extends MathJsFactory {
    * Test element wise whether two matrices are equal. The function
    * accepts both matrices and scalar values.
    * @param x First matrix to compare
-   * @param y Second amtrix to compare
+   * @param y Second matrix to compare
    * @returns Returns true when the input matrices have the same size and
    * each of their elements is equal.
    */
@@ -2622,7 +2630,7 @@ export interface MathJsInstance extends MathJsFactory {
    * compare values smaller than approximately 2.22e-16. For matrices, the
    * function is evaluated element wise.
    * @param x First value to compare
-   * @param y Second value to vcompare
+   * @param y Second value to compare
    * @returns Returns true when x is larger than y, else returns false
    */
   larger(x: MathType | string, y: MathType | string): boolean | MathCollection
@@ -2634,7 +2642,7 @@ export interface MathJsInstance extends MathJsFactory {
    * to compare values smaller than approximately 2.22e-16. For matrices,
    * the function is evaluated element wise.
    * @param x First value to compare
-   * @param y Second value to vcompare
+   * @param y Second value to compare
    * @returns Returns true when x is larger than or equal to y, else
    * returns false
    */
@@ -2647,7 +2655,7 @@ export interface MathJsInstance extends MathJsFactory {
    * to compare values smaller than approximately 2.22e-16. For matrices,
    * the function is evaluated element wise.
    * @param x First value to compare
-   * @param y Second value to vcompare
+   * @param y Second value to compare
    * @returns Returns true when x is smaller than y, else returns false
    */
   smaller(x: MathType | string, y: MathType | string): boolean | MathCollection
@@ -2659,7 +2667,7 @@ export interface MathJsInstance extends MathJsFactory {
    * used to compare values smaller than approximately 2.22e-16. For
    * matrices, the function is evaluated element wise.
    * @param x First value to compare
-   * @param y Second value to vcompare
+   * @param y Second value to compare
    * @returns Returns true when x is smaller than or equal to y, else
    * returns false
    */
@@ -2693,7 +2701,7 @@ export interface MathJsInstance extends MathJsFactory {
    * strictly, thus null is unequal with everything except null, and
    * undefined is unequal with everything except undefined.
    * @param x First value to compare
-   * @param y Second value to vcompare
+   * @param y Second value to compare
    * @returns Returns true when the compared values are unequal, else
    * returns false
    */
@@ -5816,6 +5824,13 @@ export interface MathJsChain<TValue> {
     y: MathCollection
   ): MathJsChain<MathCollection>
 
+  /**
+   * Transpose and complex conjugate a matrix. All values of the matrix are
+   * reflected over its main diagonal and then the complex conjugate is taken.
+   * This is equivalent to complex conjugation for scalars and vectors.
+   */
+  ctranspose(this: MathJsChain<MathCollection>): MathJsChain<MathCollection>
+
   /**
    * Calculate the difference between adjacent elements of the chained matrix or array.
    * @param dim The dimension to apply the difference on.
@@ -7302,6 +7317,7 @@ export const {
   apply, // @deprecated prior name of mapSlices
   concat,
   cross,
+  ctranspose,
   det,
   diag,
   dot,