Samsara\Fermat\Values\Geometry\CoordinateSystems\SphericalCoordinate

Complexity

Total Complexity

10

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Test Coverage

Coverage

59.46%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getDistanceFromOrigin()	0	3	1
A	distanceTo()	0	3	1
A	asCylindrical()	0	14	2
A	asSpherical()	0	3	1
A	__construct()	0	9	1
A	asCartesian()	0	16	2
A	getPlanarAngle()	0	3	1
A	getPolarAngle()	0	3	1

<?php

namespace Samsara\Fermat\Values\Geometry\CoordinateSystems;

use Samsara\Fermat\Types\Base\Interfaces\Coordinates\CoordinateInterface;
use Samsara\Fermat\Types\Base\Interfaces\Coordinates\ThreeDCoordinateInterface;
use Samsara\Fermat\Types\Coordinate;
use Samsara\Fermat\Values\ImmutableDecimal;

class SphericalCoordinate extends Coordinate implements ThreeDCoordinateInterface
{
    /** @var CartesianCoordinate */
    protected $cachedCartesian;
    /** @var CylindricalCoordinate */
    protected $cachedCylindrical;

    public function __construct($rho, $theta, $phi)
    {
        $data = [
            'rho' => $rho,
            'theta' => $theta,
            'phi' => $phi
        ];

        parent::__construct($data);
    }

    public function getDistanceFromOrigin(): ImmutableDecimal
    {
        return $this->getAxis('rho');
    }

    public function distanceTo(CoordinateInterface $coordinate): ImmutableDecimal
    {
        return $this->asCartesian()->distanceTo($coordinate);
    }

    public function getPolarAngle(): ImmutableDecimal
    {
        return $this->getAxis('phi');
    }

    public function getPlanarAngle(): ImmutableDecimal
    {
        return $this->getAxis('theta');
    }

    public function asCartesian(): CartesianCoordinate
    {
        if (is_null($this->cachedCartesian)) {
            $sinTheta = $this->getAxis('theta')->sin();
            $cosTheta = $this->getAxis('theta')->cos();
            $sinPhi = $this->getAxis('phi')->sin();
            $cosPhi = $this->getAxis('phi')->cos();

            $x = $this->getAxis('rho')->multiply($sinPhi)->multiply($cosTheta);
            $y = $this->getAxis('rho')->multiply($sinPhi)->multiply($sinTheta);
            $z = $this->getAxis('rho')->multiply($cosPhi);

            $this->cachedCartesian = new CartesianCoordinate($x, $y, $z);

It seems like $y can also be of type Samsara\Fermat\Values\ImmutableDecimal; however, parameter $y of Samsara\Fermat\Values\Geometry\CoordinateSystems\CartesianCoordinate::__construct() does only seem to accept null, maybe add an additional type check?

It seems like $z can also be of type Samsara\Fermat\Values\ImmutableDecimal; however, parameter $z of Samsara\Fermat\Values\Geometry\CoordinateSystems\CartesianCoordinate::__construct() does only seem to accept null, maybe add an additional type check?

        }

        return $this->cachedCartesian;
    }

    public function asSpherical(): SphericalCoordinate
    {
        return $this;
    }

    public function asCylindrical(): CylindricalCoordinate
    {
        if (is_null($this->cachedCylindrical)) {
            $sinPhi = $this->getAxis('phi')->sin();
            $cosPhi = $this->getAxis('phi')->cos();

            $rho = $this->getAxis('rho')->multiply($sinPhi);
            $theta = $this->getAxis('theta');
            $z = $this->getAxis('rho')->multiply($cosPhi);

            $this->cachedCylindrical = new CylindricalCoordinate($rho, $theta, $z);
        }

        return $this->cachedCylindrical;
    }
}