Complex - Documentation

Constructor

new Complex(re, imopt)

Source:

complex.js, line 10

Properties:

Name	Type	Description
`re`	BigFloat	The real part.
`im`	BigFloat	The imaginary part.

Parameters:

Name	Type	Attributes	Description
`re`	number \| string \| BigFloat \| Complex		Real part or Complex object
`im`	number \| string \| BigFloat	<optional>	Imaginary part

Classes

Complex

Members

operatorAdd

Source:

complex.js, line 465

operatorDiv

Source:

complex.js, line 471

operatorMul

Source:

complex.js, line 469

operatorNeg :function

Source:

complex.js, line 475

Type:

function

operatorPow

Source:

complex.js, line 473

operatorSub

Source:

complex.js, line 467

Methods

abs() → {BigFloat}

Description:

Magnitude (Absolute value) |z|

Source:

complex.js, line 145

Returns:

Type: BigFloat

acos() → {Complex}

Description:

Inverse Cosine acos(z) = -i * ln(z + i*sqrt(1 - z^2))

Source:

complex.js, line 287

Returns:

Type: Complex

acosh() → {Complex}

Description:

Inverse Hyperbolic Cosine acosh(z) = ln(z + sqrt(z^2 - 1))

Source:

complex.js, line 319

Returns:

Type: Complex

add(other) → {Complex}

Description:

Adds another complex number.

Source:

complex.js, line 32

Parameters:

Name	Type	Description
`other`	Complex \| number \| string \| BigFloat

Returns:

Type: Complex

arg() → {BigFloat}

Description:

Argument (Angle) arg(z)

Source:

complex.js, line 157

Returns:

Type: BigFloat

asin() → {Complex}

Description:

Inverse Sine asin(z) = -i * ln(iz + sqrt(1 - z^2))

Source:

complex.js, line 275

Returns:

Type: Complex

asinh() → {Complex}

Description:

Inverse Hyperbolic Sine asinh(z) = ln(z + sqrt(z^2 + 1))

Source:

complex.js, line 310

Returns:

Type: Complex

atan() → {Complex}

Description:

Inverse Tangent atan(z) = (i/2) * ln((i+z)/(i-z))

Source:

complex.js, line 298

Returns:

Type: Complex

atanh() → {Complex}

Description:

Inverse Hyperbolic Tangent atanh(z) = 0.5 * ln((1+z)/(1-z))

Source:

complex.js, line 328

Returns:

Type: Complex

conj() → {Complex}

Description:

Returns the complex conjugate.

Source:

complex.js, line 340

Returns:

Type: Complex

cos() → {Complex}

Description:

Trigonometric Cosine cos(z) cos(x+iy) = cos(x)cosh(y) - i sin(x)sinh(y)

Source:

complex.js, line 214

Returns:

Type: Complex

cosh() → {Complex}

Description:

Hyperbolic Cosine cosh(z) cosh(x+iy) = cosh(x)cos(y) + i sinh(x)sin(y)

Source:

complex.js, line 253

Returns:

Type: Complex

div(other) → {Complex}

Description:

Divides by another complex number.

Source:

complex.js, line 75

Parameters:

Name	Type	Description
`other`	Complex \| number \| string \| BigFloat

Returns:

Type: Complex

equals(b) → {boolean}

Description:

Checks for equality with another complex number.

Source:

complex.js, line 357

Parameters:

Name	Type	Description
`b`	Complex \| number \| string \| BigFloat

Returns:

Type: boolean

exp() → {Complex}

Description:

Complex Exponential e^z

Source:

complex.js, line 178

Returns:

Type: Complex

isAlmostZero() → {boolean}

Description:

Checks if the complex number is almost zero.

Source:

complex.js, line 366

Returns:

Type: boolean

isZero() → {boolean}

Description:

Checks if the complex number is exactly zero.

Source:

complex.js, line 374

Returns:

Type: boolean

log() → {Complex}

Description:

Complex Natural Logarithm ln(z)

Source:

complex.js, line 188

Returns:

Type: Complex

mul(other) → {Complex}

Description:

Multiplies by another complex number.

Source:

complex.js, line 52

Parameters:

Name	Type	Description
`other`	Complex \| number \| string \| BigFloat

Returns:

Type: Complex

neg() → {Complex}

Description:

Negates the complex number.

Source:

complex.js, line 348

Returns:

Type: Complex

pow(other) → {Complex}

Description:

Raises this complex number to the power of another.

Source:

complex.js, line 128

Parameters:

Name	Type	Description
`other`	Complex \| number \| string \| BigFloat

Returns:

Type: Complex

sin() → {Complex}

Description:

Trigonometric Sine sin(z) sin(x+iy) = sin(x)cosh(y) + i cos(x)sinh(y)

Source:

complex.js, line 199

Returns:

Type: Complex

sinh() → {Complex}

Description:

Hyperbolic Sine sinh(z) sinh(x+iy) = sinh(x)cos(y) + i cosh(x)sin(y)

Source:

complex.js, line 238

Returns:

Type: Complex

sqrt() → {Complex}

Description:

Complex Square Root sqrt(z)

Source:

complex.js, line 165

Returns:

Type: Complex

sub(other) → {Complex}

Description:

Subtracts another complex number.

Source:

complex.js, line 42

Parameters:

Name	Type	Description
`other`	Complex \| number \| string \| BigFloat

Returns:

Type: Complex

tan() → {Complex}

Description:

Trigonometric Tangent tan(z)

Source:

complex.js, line 229

Returns:

Type: Complex

tanh() → {Complex}

Description:

Hyperbolic Tangent tanh(z)

Source:

complex.js, line 267

Returns:

Type: Complex

toString(baseopt, precisionopt, prettyopt) → {string}

Description:

Converts the complex number to a string.

Source:

complex.js, line 385

Parameters:

Name	Type	Attributes	Default	Description
`base`	number	<optional>	`10`
`precision`	number	<optional>	`-1`
`pretty`	boolean	<optional>	`false`	pretty print

Returns:

Type: string

(static) fromPolar(r, theta) → {Complex}

Description:

Creates a complex number from polar coordinates.

Source:

complex.js, line 426

Parameters:

Name	Type	Description
`r`	number \| string \| BigFloat	The radius.
`theta`	number \| string \| BigFloat	The angle.

Returns:

Type: Complex

(static) fromString(s) → {Complex}

Description:

Creates a complex number from a string.

Source:

complex.js, line 437

Parameters:

Name	Type	Description
`s`	string

Returns:

Type: Complex