ValueObjects\Number\Complex

Complexity

Total Complexity

13

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	fromNative()	0	14	2
A	fromPolar()	0	10	1
A	__construct()	0	5	1
A	sameValueAs()	0	9	3
A	toNative()	0	7	1
A	getReal()	0	4	1
A	getIm()	0	4	1
A	getModulus()	0	8	1
A	getArgument()	0	8	1
A	__toString()	0	9	1

<?php

namespace ValueObjects\Number;

use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;

class Complex implements ValueObjectInterface, NumberInterface
{
    /** @var Real */
    protected $real;

    /** @var Real */
    protected $im;

    /**
     * Returns a new Complex object from native PHP arguments
     *
     * @param  float                        $real Real part of the complex number

There is no parameter named $real. Was it maybe removed?

     * @param  float                        $im   Imaginary part of the complex number

There is no parameter named $im. Was it maybe removed?

     * @return Complex|ValueObjectInterface
     * @throws \BadMethodCallException
     */
    public static function fromNative()
    {
        $args = \func_get_args();

        if (\count($args) != 2) {
            throw new \BadMethodCallException('You must provide 2 arguments: 1) real part, 2) imaginary part');
        }

        $real    = Real::fromNative($args[0]);
        $im      = Real::fromNative($args[1]);
        $complex = new static($real, $im);

        return $complex;
    }

    /**
     * Returns a Complex given polar coordinates
     *
     * @param  Real    $modulus
     * @param  Real    $argument
     * @return Complex
     */
    public static function fromPolar(Real $modulus, Real $argument)
    {
        $realValue = $modulus->toNative() * \cos($argument->toNative());
        $imValue   = $modulus->toNative() * \sin($argument->toNative());
        $real      = new Real($realValue);
        $im        = new Real($imValue);
        $complex   = new static($real, $im);

        return $complex;
    }

    /**
     * Returns a Complex object give its real and imaginary parts as parameters
     *
     * @param Real $real
     * @param Real $im
     */
    public function __construct(Real $real, Real $im)
    {
        $this->real = $real;
        $this->im   = $im;
    }

    public function sameValueAs(ValueObjectInterface $complex)
    {
        if (false === Util::classEquals($this, $complex)) {
            return false;
        }

        return $this->getReal()->sameValueAs($complex->getReal()) &&

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getReal() does only exist in the following implementations of said interface: ValueObjects\Number\Complex.

               $this->getIm()->sameValueAs($complex->getIm());

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method getIm() does only exist in the following implementations of said interface: ValueObjects\Number\Complex.

    }

    /**
     * Returns the native value of the real and imaginary parts as an array
     *
     * @return array
     */
    public function toNative()
    {
        return array(
            $this->getReal()->toNative(),
            $this->getIm()->toNative()
        );
    }

    /**
     * Returns the real part of the complex number
     *
     * @return Real
     */
    public function getReal()
    {
        return clone $this->real;
    }

    /**
     * Returns the imaginary part of the complex number
     *
     * @return Real
     */
    public function getIm()
    {
        return clone $this->im;
    }

    /**
     * Returns the modulus (or absolute value or magnitude) of the Complex number
     *
     * @return Real
     */
    public function getModulus()
    {
        $real = $this->getReal()->toNative();
        $im   = $this->getIm()->toNative();
        $mod  = \sqrt(\pow($real, 2) + \pow($im, 2));

        return new Real($mod);
    }

    /**
     * Returns the argument (or phase) of the Complex number
     *
     * @return Real
     */
    public function getArgument()
    {
        $real = $this->getReal()->toNative();
        $im   = $this->getIm()->toNative();
        $arg  = \atan2($im, $real);

        return new Real($arg);
    }

    /**
     * Returns a native string version of the Complex object in format "${real} +|- ${complex}i"
     *
     * @return string
     */
    public function __toString()
    {
        $format = '%g %+gi';
        $real   = $this->getReal()->toNative();
        $im     = $this->getIm()->toNative();
        $string = \sprintf($format, $real, $im);

        return \preg_replace('/(\+|-)/', '$1 ', $string);
    }
}