Nubs\Geometron\Point

Complexity

Total Complexity

8

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	createFromTerms()	0	4	1
A	vector()	0	4	1
A	terms()	0	4	1
A	dimension()	0	4	1
A	isEqual()	0	4	1
A	isSameSpace()	0	4	1
A	center()	0	4	1

<?php
namespace Nubs\Geometron;

use Nubs\Vectorix\Vector;

/**
 * This class represents an immutable point in euclidean geometry and its
 * associated operations.
 *
 * Instances of this class will not change state.  Any operations on the point
 * will return a new point with the new state.
 */
class Point implements Finite
{
    /** @type \Nubs\Vectorix\Vector A vector representing the point. */
    protected $_vector;

    /**
     * Initalize the point from a vector.
     *
     * @api
     * @param \Nubs\Vectorix\Vector $vector The vector representing the point's terms.
     */
    public function __construct(Vector $vector)
    {
        $this->_vector = $vector;
    }

    /**
     * Creates a point from its terms.
     *
     * @api
     * @param array<int|float> $terms The terms (x, y, z, etc.) of the point.
     * @return self The point with the given terms.
     */
    public static function createFromTerms(array $terms)
    {
        return new static(new Vector($terms));
    }

    /**
     * Get the vector representing the point's location.
     *
     * @api
     * @return \Nubs\Vectorix\Vector The vector representing the point.
     */
    public function vector()
    {
        return $this->_vector;
    }

    /**
     * Get the terms of the point.
     *
     * @api
     * @return array<int|float> The terms of the point.
     */
    public function terms()
    {
        return $this->vector()->components();
    }

    /**
     * Get the dimension of the point.
     *
     * @api
     * @return int The dimension of the point.
     */
    public function dimension()
    {
        return $this->vector()->dimension();
    }

    /**
     * Check whether the given point is the same as this point.
     *
     * @api
     * @param self $b The point to check for equality.
     * @return bool True if the points are equal and false otherwise.
     */
    public function isEqual(self $b)
    {
        return $this->vector()->isEqual($b->vector());
    }

    /**
     * Check whether the given point belongs to the same geometric space as this
     * point.
     *
     * @api
     * @param self $b The point to check.
     * @return bool True if the points are in the same geometric space and false otherwise.
     */
    public function isSameSpace(self $b)
    {
        return $this->vector()->isSameVectorSpace($b->vector());
    }

    /**
     * The center of the point is just the point itself.
     *
     * @api
     * @return \Nubs\Geometron\Point This point.
     * @see \Nubs\Geometron\Finite::center()
     */
    public function center()
    {
        return $this;
    }
}