Complex\Complex Class Reference

Collaboration diagram for Complex\Complex:

Public Member Functions
	__construct ($realPart=0.0, $imaginaryPart=null, $suffix='i')
	getReal ()
	Gets the real part of this complex number. More...
	getImaginary ()
	Gets the imaginary part of this complex number. More...
	getSuffix ()
	Gets the suffix of this complex number. More...
	isReal ()
	Returns true if this is a real value, false if a complex value. More...
	isComplex ()
	Returns true if this is a complex value, false if a real value. More...
	format ()
	__toString ()
	reverse ()
	Returns the reverse of this complex number. More...
	invertImaginary ()
	invertReal ()
	__call ($functionName, $arguments)
	Returns the result of the function call or operation. More...

Static Public Member Functions
static	validateComplexArgument ($complex)
	Validates whether the argument is a valid complex number, converting scalar or array values if possible. More...

Data Fields
const	EULER = 2.7182818284590452353602874713526624977572
	Euler's Number. More...
const	NUMBER_SPLIT_REGEXP
	Regexp to split an input string into real and imaginary components and suffix More...

Protected Attributes
	$realPart = 0.0
	$imaginaryPart = 0.0
	$suffix

Static Protected Attributes
static	$functions
static	$operations

Static Private Member Functions
static	parseComplex ($complexNumber)
	Validates whether the argument is a valid complex number, converting scalar or array values if possible. More...

Detailed Description

Definition at line 60 of file Complex.php.

Constructor & Destructor Documentation

__construct()

Complex\Complex::__construct	(		$realPart = 0.0,
			$imaginaryPart = null,
			$suffix = 'i'
	)

Definition at line 168 of file Complex.php.

    {
        if ($imaginaryPart === null) {
            if (is_array($realPart)) {
                // We have an array of (potentially) real and imaginary parts, and any suffix
                list ($realPart, $imaginaryPart, $suffix) = array_values($realPart) + [0.0, 0.0, 'i'];
            } elseif ((is_string($realPart)) || (is_numeric($realPart))) {
                // We've been given a string to parse to extract the real and imaginary parts, and any suffix
                list($realPart, $imaginaryPart, $suffix) = self::parseComplex($realPart);
            }
        }

        if ($imaginaryPart != 0.0 && empty($suffix)) {
            $suffix = 'i';
        } elseif ($imaginaryPart == 0.0 && !empty($suffix)) {
            $suffix = '';
        }

        // Set parsed values in our properties
        $this->realPart = (float) $realPart;
        $this->imaginaryPart = (float) $imaginaryPart;
        $this->suffix = strtolower($suffix ?? '');
    }

Member Function Documentation

__call()

Complex\Complex::__call	(		$functionName,
			$arguments
	)

Returns the result of the function call or operation.

Returns

Complex|float

Exceptions

Exception|

Definition at line 374 of file Complex.php.

    {
        $functionName = strtolower(str_replace('_', '', $functionName));

        // Test for function calls
        if (in_array($functionName, self::$functions, true)) {
            $functionName = "\\" . __NAMESPACE__ . "\\{$functionName}";
            return $functionName($this, ...$arguments);
        }
        // Test for operation calls
        if (in_array($functionName, self::$operations, true)) {
            $functionName = "\\" . __NAMESPACE__ . "\\{$functionName}";
            return $functionName($this, ...$arguments);
        }
        throw new Exception('Complex Function or Operation does not exist');
    }

__toString()

Complex\Complex::__toString

(

)

Definition at line 265 of file Complex.php.

                                : string
    {
        return $this->format();
    }

format()

Complex\Complex::format

(

)

Definition at line 242 of file Complex.php.

                            : string
    {
        $str = "";
        if ($this->imaginaryPart != 0.0) {
            if (\abs($this->imaginaryPart) != 1.0) {
                $str .= $this->imaginaryPart . $this->suffix;
            } else {
                $str .= (($this->imaginaryPart < 0.0) ? '-' : '') . $this->suffix;
            }
        }
        if ($this->realPart != 0.0) {
            if (($str) && ($this->imaginaryPart > 0.0)) {
                $str = "+" . $str;
            }
            $str = $this->realPart . $str;
        }
        if (!$str) {
            $str = "0.0";
        }

        return $str;
    }

getImaginary()

Complex\Complex::getImaginary

(

)

Gets the imaginary part of this complex number.

Returns

Float

Definition at line 207 of file Complex.php.

                                  : float
    {
        return $this->imaginaryPart;
    }

getReal()

Complex\Complex::getReal

(

)

Gets the real part of this complex number.

Returns

Float

Definition at line 197 of file Complex.php.

                             : float
    {
        return $this->realPart;
    }

getSuffix()

Complex\Complex::getSuffix

(

)

Gets the suffix of this complex number.

Returns

String

Definition at line 217 of file Complex.php.

                               : string
    {
        return $this->suffix;
    }

invertImaginary()

Complex\Complex::invertImaginary

(

)

Definition at line 302 of file Complex.php.

                                     : Complex
    {
        return new Complex(
            $this->realPart,
            $this->imaginaryPart * -1,
            ($this->imaginaryPart == 0.0) ? null : $this->suffix
        );
    }

invertReal()

Complex\Complex::invertReal

(

)

Definition at line 311 of file Complex.php.

                                : Complex
    {
        return new Complex(
            $this->realPart * -1,
            $this->imaginaryPart,
            ($this->imaginaryPart == 0.0) ? null : $this->suffix
        );
    }

isComplex()

Complex\Complex::isComplex

(

)

Returns true if this is a complex value, false if a real value.

Returns

Bool

Definition at line 237 of file Complex.php.

                               : bool
    {
        return !$this->isReal();
    }

isReal()

Complex\Complex::isReal

(

)

Returns true if this is a real value, false if a complex value.

Returns

Bool

Definition at line 227 of file Complex.php.

                            : bool
    {
        return $this->imaginaryPart == 0.0;
    }

parseComplex()

static Complex\Complex::parseComplex (   $complexNumber )

staticprivate

Validates whether the argument is a valid complex number, converting scalar or array values if possible.

Parameters

mixed

$complexNumber

The value to parse

Returns

array

Exceptions

Exception

If the argument isn't a Complex number or cannot be converted to one

Definition at line 109 of file Complex.php.

    {
        // Test for real number, with no imaginary part
        if (is_numeric($complexNumber)) {
            return [$complexNumber, 0, null];
        }

        // Fix silly human errors
        $complexNumber = str_replace(
            ['+-', '-+', '++', '--'],
            ['-', '-', '+', '+'],
            $complexNumber
        );

        // Basic validation of string, to parse out real and imaginary parts, and any suffix
        $validComplex = preg_match(
            self::NUMBER_SPLIT_REGEXP,
            $complexNumber,
            $complexParts
        );

        if (!$validComplex) {
            // Neither real nor imaginary part, so test to see if we actually have a suffix
            $validComplex = preg_match('/^([\-\+]?)([ij])$/ui', $complexNumber, $complexParts);
            if (!$validComplex) {
                throw new Exception('Invalid complex number');
            }
            // We have a suffix, so set the real to 0, the imaginary to either 1 or -1 (as defined by the sign)
            $imaginary = 1;
            if ($complexParts[1] === '-') {
                $imaginary = 0 - $imaginary;
            }
            return [0, $imaginary, $complexParts[2]];
        }

        // If we don't have an imaginary part, identify whether it should be +1 or -1...
        if (($complexParts[4] === '') && ($complexParts[9] !== '')) {
            if ($complexParts[7] !== $complexParts[9]) {
                $complexParts[4] = 1;
                if ($complexParts[8] === '-') {
                    $complexParts[4] = -1;
                }
            } else {
                // ... or if we have only the real and no imaginary part
                //  (in which case our real should be the imaginary)
                $complexParts[4] = $complexParts[1];
                $complexParts[1] = 0;
            }
        }

        // Return real and imaginary parts and suffix as an array, and set a default suffix if user input lazily
        return [
            $complexParts[1],
            $complexParts[4],
            !empty($complexParts[9]) ? $complexParts[9] : 'i'
        ];
    }

reverse()

Complex\Complex::reverse

(

)

Returns the reverse of this complex number.

Returns

Complex

Definition at line 293 of file Complex.php.

                             : Complex
    {
        return new Complex(
            $this->imaginaryPart,
            $this->realPart,
            ($this->realPart == 0.0) ? null : $this->suffix
        );
    }

validateComplexArgument()

static Complex\Complex::validateComplexArgument (   $complex )

static

Validates whether the argument is a valid complex number, converting scalar or array values if possible.

Parameters

mixed

$complex

The value to validate

Returns

Complex

Exceptions

Exception

If the argument isn't a Complex number or cannot be converted to one

Definition at line 277 of file Complex.php.

                                                            : Complex
    {
        if (is_scalar($complex) || is_array($complex)) {
            $complex = new Complex($complex);
        } elseif (!is_object($complex) || !($complex instanceof Complex)) {
            throw new Exception('Value is not a valid complex number');
        }

        return $complex;
    }

Field Documentation

$functions

Complex\Complex::$functions

staticprotected

Definition at line 320 of file Complex.php.

$imaginaryPart

Complex\Complex::$imaginaryPart = 0.0

protected

Definition at line 94 of file Complex.php.

$operations

Complex\Complex::$operations

staticprotected

Initial value:

= [
        'add',
        'subtract',
        'multiply',
        'divideby',
        'divideinto',
    ]

Definition at line 360 of file Complex.php.

$realPart

Complex\Complex::$realPart = 0.0

protected

Definition at line 89 of file Complex.php.

$suffix

Complex\Complex::$suffix

protected

Definition at line 99 of file Complex.php.

EULER

const Complex\Complex::EULER = 2.7182818284590452353602874713526624977572

Euler's Number.

Definition at line 65 of file Complex.php.

NUMBER_SPLIT_REGEXP

const Complex\Complex::NUMBER_SPLIT_REGEXP

Initial value:

=
        '` ^
            (                                   # Real part
                [-+]?(\d+\.?\d*|\d*\.?\d+)          # Real value (integer or float)
                ([Ee][-+]?[0-2]?\d{1,3})?           # Optional real exponent for scientific format
            )
            (                                   # Imaginary part
                [-+]?(\d+\.?\d*|\d*\.?\d+)          # Imaginary value (integer or float)
                ([Ee][-+]?[0-2]?\d{1,3})?           # Optional imaginary exponent for scientific format
            )?
            (                                   # Imaginary part is optional
                ([-+]?)                             # Imaginary (implicit 1 or -1) only
                ([ij]?)                             # Imaginary i or j - depending on whether mathematical or engineering
            )
        $`uix'

Regexp to split an input string into real and imaginary components and suffix

Definition at line 70 of file Complex.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/markbaker/complex/classes/src/Complex.php