Skip to content

ComplexNumber

Properties

real

protected \Qubus\ValueObjects\Number\RealNumber $real

im

protected \Qubus\ValueObjects\Number\RealNumber $im

Methods

fromNative

Returns a new ComplexNumber object from native PHP arguments

public static fromNative(): \Qubus\ValueObjects\Number\ComplexNumber|\Qubus\ValueObjects\ValueObject
  • This method is static.

Throws:

fromPolar

Returns a ComplexNumber given polar coordinates

public static fromPolar(\Qubus\ValueObjects\Number\RealNumber $modulus, \Qubus\ValueObjects\Number\RealNumber $argument): \Qubus\ValueObjects\Number\ComplexNumber
  • This method is static.

Parameters:

Parameter Type Description
$modulus \Qubus\ValueObjects\Number\RealNumber
$argument \Qubus\ValueObjects\Number\RealNumber

Throws:

__construct

Returns a ComplexNumber object give its real and imaginary parts as parameters

public __construct(\Qubus\ValueObjects\Number\RealNumber $real, \Qubus\ValueObjects\Number\RealNumber $im): mixed

Parameters:

Parameter Type Description
$real \Qubus\ValueObjects\Number\RealNumber
$im \Qubus\ValueObjects\Number\RealNumber

equals

Compare two ValueObject and tells whether they can be considered equal

public equals(\Qubus\ValueObjects\Number\ComplexNumber|\Qubus\ValueObjects\ValueObject $complex): bool

Parameters:

Parameter Type Description
$complex \Qubus\ValueObjects\Number\ComplexNumber|\Qubus\ValueObjects\ValueObject

toNative

Returns the native value of the real and imaginary parts as an array

public toNative(): array

getRealNumber

Returns the real part of the complex number.

public getRealNumber(): \Qubus\ValueObjects\Number\RealNumber

getIm

Returns the imaginary part of the complex number.

public getIm(): \Qubus\ValueObjects\Number\RealNumber

getModulus

Returns the modulus (or absolute value or magnitude) of the ComplexNumber number.

public getModulus(): \Qubus\ValueObjects\Number\RealNumber

Throws:

getArgument

Returns the argument (or phase) of the ComplexNumber number.

public getArgument(): \Qubus\ValueObjects\Number\RealNumber

Throws:

__toString

Returns a native string version of the ComplexNumber object in format "${real} +|- ${complex}i"

public __toString(): string

Automatically generated on 2025-10-13