@babia/complex@1.1.1

Built and signed on GitHub Actions

Built and signed on GitHub Actions

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
/**
 * A package provides implementation of complex numbers and some mathematical
 * functions for complex numbers.
 *
 * The `Complex` class represents a complex number which has a real part and an
 * imaginary part. It is expressed in form `a + bi`, where:
 * - `a`: the real part
 * - `b`: the imaginary part
 * - `i`: the imaginary unit
 *
 * You can also create a complex number using `cmplx` function.
 *
 * ```ts
 * import { cmplx } from "@babia/complex";
 *
 * const cmplx1 = cmplx(1, 9); // 1 + 9i
 * const cmplx2 = cmplx(5, 4); // 5 + 4i
 * ```
 *
 * The `Complex` class has methods to perform basic operations, such as `add()`,
 * `sub()`, etc.
 *
 * ```ts
 * import { cmplx } from "@babia/complex";
 *
 * const cmplx1 = cmplx(1, 9); // 1 + 9i
 * const cmplx2 = cmplx(5, 4); // 5 + 4i
 *
 * cmplx1.add(cmplx2); // (1 + 9i) + (5 + 4i)
 * cmplx1.sub(cmplx2); // (1 + 9i) - (5 + 4i)
 * ```
 *
 * Besides that, this package also has `ComplexMath` which provides basic
 * mathematics functionality for complex numbers, such as `sin()`, `atan()`,
 * `log()`, etc.
 *
 * ```ts
 * import { ComplexMath, cmplx } from "@babia/complex";
 *
 * const cmplx1 = cmplx(1, 9); // 1 + 9i
 * const cmplx2 = cmplx(5, 4); // 5 + 4i
 *
 * ComplexMath.sqrt(cmplx1);
 * ComplexMath.log(cmplx1);
 * ComplexMath.pow(cmplx2, 3);
 * ```
 *
 * Based on http://netlib.sandia.gov/cephes/c9x-complex and
 * https://pkg.go.dev/math/cmplx.
 *
 * @module
 */

export * from "./src/complex.ts";
export * as ComplexMath from "./src/math/mod.ts";