PHP Class ValueObjects\Number\Complex

Inheritance: implements ValueObjects\ValueObjectInterface, implements ValueObjects\Number\NumberInterface
Show file Open project: nicolopignatelli/valueobjects Class Usage Examples

Protected Properties

Property Type Description
$im ValueObjects\Number\Real
$real ValueObjects\Number\Real

Public Methods

Method Description
__construct ( ValueObjects\Number\Real $real, ValueObjects\Number\Real $im ) Returns a Complex object give its real and imaginary parts as parameters
__toString ( ) : string Returns a native string version of the Complex object in format "${real} +|- ${complex}i"
fromNative ( ) : Complex | ValueObjects\ValueObjectInterface Returns a new Complex object from native PHP arguments
fromPolar ( ValueObjects\Number\Real $modulus, ValueObjects\Number\Real $argument ) : Complex Returns a Complex given polar coordinates
getArgument ( ) : ValueObjects\Number\Real Returns the argument (or phase) of the Complex number
getIm ( ) : ValueObjects\Number\Real Returns the imaginary part of the complex number
getModulus ( ) : ValueObjects\Number\Real Returns the modulus (or absolute value or magnitude) of the Complex number
getReal ( ) : ValueObjects\Number\Real Returns the real part of the complex number
sameValueAs ( ValueObjects\ValueObjectInterface $complex )
toNative ( ) : array Returns the native value of the real and imaginary parts as an array

Method Details

__construct() public method

Returns a Complex object give its real and imaginary parts as parameters
public __construct ( ValueObjects\Number\Real $real, ValueObjects\Number\Real $im )
$real ValueObjects\Number\Real
$im ValueObjects\Number\Real

__toString() public method

Returns a native string version of the Complex object in format "${real} +|- ${complex}i"
public __toString ( ) : string
return string

fromNative() public static method

Returns a new Complex object from native PHP arguments
public static fromNative ( ) : Complex | ValueObjects\ValueObjectInterface
return Complex | ValueObjects\ValueObjectInterface

fromPolar() public static method

Returns a Complex given polar coordinates
public static fromPolar ( ValueObjects\Number\Real $modulus, ValueObjects\Number\Real $argument ) : Complex
$modulus ValueObjects\Number\Real
$argument ValueObjects\Number\Real
return Complex

getArgument() public method

Returns the argument (or phase) of the Complex number
public getArgument ( ) : ValueObjects\Number\Real
return ValueObjects\Number\Real

getIm() public method

Returns the imaginary part of the complex number
public getIm ( ) : ValueObjects\Number\Real
return ValueObjects\Number\Real

getModulus() public method

Returns the modulus (or absolute value or magnitude) of the Complex number
public getModulus ( ) : ValueObjects\Number\Real
return ValueObjects\Number\Real

getReal() public method

Returns the real part of the complex number
public getReal ( ) : ValueObjects\Number\Real
return ValueObjects\Number\Real

sameValueAs() public method

public sameValueAs ( ValueObjects\ValueObjectInterface $complex )
$complex ValueObjects\ValueObjectInterface

toNative() public method

Returns the native value of the real and imaginary parts as an array
public toNative ( ) : array
return array

Property Details

$im protected property

protected Real,ValueObjects\Number $im
return ValueObjects\Number\Real

$real protected property

protected Real,ValueObjects\Number $real
return ValueObjects\Number\Real