CartesianCoordinate::getPolarAngle() - Code Metrics - JordanRL/Fermat - Measure and Improve Code Quality continuously with Scrutinizer

CartesianCoordinate::getPolarAngle() A
last analyzed 2022-10-22 04:55 UTC

↳ Parent: CartesianCoordinate
Complexity

Conditions	3
Paths	3
Size

Total Lines	14
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	6
CRAP Score	3
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	3
dl	0
loc	14
ccs	6
cts	6
cp	1
crap	3
rs	10
c	1
b	0
f	0
eloc	8
nc	3
nop	0
<?php

namespace Samsara\Fermat\Coordinates\Values;

use ReflectionException;
use Samsara\Exceptions\SystemError\LogicalError\IncompatibleObjectState;
use Samsara\Exceptions\UsageError\IntegrityConstraint;
use Samsara\Exceptions\UsageError\OptionalExit;
use Samsara\Fermat\Core\Numbers;
use Samsara\Fermat\Coordinates\Types\Base\Interfaces\Coordinates\CoordinateInterface;
use Samsara\Fermat\Coordinates\Types\Base\Interfaces\Coordinates\ThreeDCoordinateInterface;
use Samsara\Fermat\Coordinates\Types\Base\Interfaces\Coordinates\TwoDCoordinateInterface;
use Samsara\Fermat\Coordinates\Types\Coordinate;
use Samsara\Fermat\Core\Values\ImmutableDecimal;

class CartesianCoordinate extends Coordinate implements TwoDCoordinateInterface, ThreeDCoordinateInterface
{

    /**
     * CartesianCoordinate constructor.
     *
     * @param $x
     * @param null $y

     * @param null $z

     */
    public function __construct($x, $y = null, $z = null)
    {
        $data = [
            'x' => $x
        ];

        if (!is_null($y)) {

            $data['y'] = $y;
            if (!is_null($z)) {
                $data['z'] = $z;
            }
        } else if (!is_null($z)) {

            $data['y'] = $z;
        }

        parent::__construct($data);

        if (!array_key_exists('y', $this->parameters)) {
            $this->parameters['y'] = 1;
        }

        if (!array_key_exists('z', $this->parameters)) {
            $this->parameters['z'] = 2;
        }
    }

    /**
     * @param $axis
     *
     * @return ImmutableDecimal
     * @throws ReflectionException
     * @throws IntegrityConstraint
     */
    public function getAxis($axis): ImmutableDecimal
    {
        if (is_int($axis)) {
            $axisIndex = $axis;
        } else {
            $axisIndex = $this->parameters[$axis];
        }

        if (!$this->values->hasIndex($axisIndex)) {
            return Numbers::makeZero();
        }

        return $this->getAxisByIndex($axisIndex);
    }

    /**
     * @return ImmutableDecimal
     */
    public function getDistanceFromOrigin(?int $scale = null): ImmutableDecimal
    {
        $scale = $scale ?? 10;
        $intScale = $scale + 2;

        $x = 0;

        if ($this->numberOfDimensions() > 1) {
            $y = 0;
        } else {
            $y = null;
        }

        if ($this->numberOfDimensions() > 2) {
            $z = 0;
        } else {
            $z = null;
        }

        return $this->distanceTo(new CartesianCoordinate($x, $y, $z), $intScale)->roundToScale($scale);
        return $this->distanceTo(new CartesianCoordinate($x, /** @scrutinizer ignore-type */ $y, $z), $intScale)->roundToScale($scale);
    }

    /**
     * @param CoordinateInterface $coordinate
     *
     * @return ImmutableDecimal
     * @throws IntegrityConstraint
     * @throws ReflectionException
     */
    public function distanceTo(CoordinateInterface $coordinate, ?int $scale = null): ImmutableDecimal
    {
        $scale = $scale ?? 10;
        $intScale = $scale + 2;

        if (!($coordinate instanceof CartesianCoordinate)) {
            $coordinate = $coordinate->asCartesian();
        }

        $n = Numbers::makeZero($intScale);

        $firstValues = ($this->numberOfDimensions() >= $coordinate->numberOfDimensions()) ? $this->axesValues() : $coordinate->axesValues();
        $secondValues = ($this->numberOfDimensions() >= $coordinate->numberOfDimensions()) ? $coordinate->axesValues() : $this->axesValues();

        foreach ($firstValues as $index => $value) {
            $n = $n->add($secondValues[$index]->subtract($value)->pow(2));
        }

        return $n->sqrt($intScale)->roundToScale($scale);
    }

    /**
     * @return CartesianCoordinate
     */
    public function asCartesian(): CartesianCoordinate
    {
        return $this;
    }

    /**
     * @return ImmutableDecimal
     * @throws IncompatibleObjectState
     */
    public function getPolarAngle(): ImmutableDecimal
    {
        if ($this->numberOfDimensions() === 2) {
            return $this->asPolar()->getPolarAngle();
        }

        if ($this->numberOfDimensions() === 3) {
            return $this->asSpherical()->getPolarAngle();
        }

        throw new IncompatibleObjectState(
            'Can only get a polar angle for a CartesianCoordinate of 2 or 3 dimensions.',
            'Ensure the CartesianCoordinate has 2 or 3 dimensions.',
            'Cannot get the polar angle for a CartesianCoordinate unless it has exactly 2 or 3 dimensions.'
        );
    }

    /**
     * @return ImmutableDecimal
     * @throws IncompatibleObjectState
     */
    public function getPlanarAngle(): ImmutableDecimal
    {
        if ($this->numberOfDimensions() === 2) {
            return $this->getPolarAngle();
        }

        if ($this->numberOfDimensions() === 3) {
            return $this->asSpherical()->getPlanarAngle();
        }

        throw new IncompatibleObjectState(
            'Can only get a polar angle for a CartesianCoordinate of 2 or 3 dimensions.',
            'Ensure the CartesianCoordinate has 2 or 3 dimensions.',
            'Cannot get the polar angle for a CartesianCoordinate unless it has exactly 2 or 3 dimensions.'
        );
    }

    /**
     * @return SphericalCoordinate
     * @throws IncompatibleObjectState
     */
    public function asSpherical(): SphericalCoordinate
    {
        if ($this->numberOfDimensions() !== 3) {
            throw new IncompatibleObjectState(
                'Can only get SphericalCoordinate for a CartesianCoordinate of 3 dimensions.',
                'Ensure the CartesianCoordinate has 3 dimensions.',
                'Cannot get the SphericalCoordinate for a CartesianCoordinate unless it has exactly 3 dimensions.'
            );
        }

        $rho = $this->getDistanceFromOrigin();
        $theta = $this->getAxis('y')->divide($this->getAxis('x'))->arctan();
        $phi = $this->getAxis('z')->divide($rho)->arccos();

        return new SphericalCoordinate($rho, $theta, $phi);
    }

    /**
     * @return CylindricalCoordinate
     * @throws IncompatibleObjectState
     * @throws IntegrityConstraint
     * @throws ReflectionException
     */
    public function asCylindrical(): CylindricalCoordinate
    {
        if ($this->numberOfDimensions() !== 3) {
            throw new IncompatibleObjectState(
                'Can only get CylindricalCoordinate for a CartesianCoordinate of 3 dimensions.',
                'Ensure the CartesianCoordinate has 3 dimensions.',
                'Cannot get the CylindricalCoordinate for a CartesianCoordinate unless it has exactly 3 dimensions.'
            );
        }

        $z = $this->getAxis('z');
        $r = $this->distanceTo(new CartesianCoordinate(0, 0, $z));
        $theta = $this->getAxis('y')->divide($this->getAxis('x'))->arctan();

        return new CylindricalCoordinate($r, $theta, $z);
    }

    /**
     * @param int|null $scale
     * @return PolarCoordinate
     * @throws IncompatibleObjectState
     * @throws IntegrityConstraint
     * @throws OptionalExit
     */
    public function asPolar(?int $scale = null): PolarCoordinate
    {
        $scale = $scale ?? 10;
        $intScale = $scale + 3;

        if ($this->numberOfDimensions() !== 2) {
            throw new IncompatibleObjectState(
                'Can only get PolarCoordinate for a CartesianCoordinate of 2 dimensions.',
                'Ensure the CartesianCoordinate has 2 dimensions.',
                'Cannot get the PolarCoordinate for a CartesianCoordinate unless it has exactly 2 dimensions.'
            );
        }

        $rho = $this->getDistanceFromOrigin($intScale);

        if ($rho->isEqual(0)) {
            throw new OptionalExit(
                'Attempted to convert a CartesianCoordinate at the origin into PolarCoordinate',
                'Do not attempt to do this.',
                'The origin has an undefined polar angle in the polar coordinate system.'
            );
        }

        if ($this->getAxis('x')->isEqual(0)) {
            $theta = Numbers::makePi($intScale)->divide(2);

            if ($this->getAxis('y')->isNegative()) {
                $theta = $theta->multiply(-1);
            }
        } else {
            /** @var ImmutableDecimal $theta */
            $theta = $this->getAxis('y')->divide($this->getAxis('x'), $intScale)->arctan($intScale);
        }

        return new PolarCoordinate($rho->roundToScale($scale), $theta->roundToScale($scale));
    }
}
JordanRL / Fermat

CartesianCoordinate::getPolarAngle() A last analyzed 2022-10-22 04:55 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CartesianCoordinate::getPolarAngle() A
last analyzed 2022-10-22 04:55 UTC
