Bisarca\Graph\Graph\Descriptor\DegreeTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	getEdgeSet()	0	1	?
	getVertexSet()	0	1	?
A	getVertexDegree()	0	4	1
A	getVertexInDegree()	0	10	3
A	getVertexOutDegree()	0	10	3
A	getMaxDegree()	0	10	2
A	getMinDegree()	0	10	2
A	isIsolatedVertex()	0	4	1
A	isLeafVertex()	0	4	1
A	isDominatingVertex()	0	4	1

<?php

/*
 * This file is part of the bisarca/graph package.
 *
 * (c) Emanuele Minotto <minottoemanuele@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Bisarca\Graph\Graph\Descriptor;

use Bisarca\Graph\Edge\Set as EdgeSet;
use Bisarca\Graph\Vertex\Set as VertexSet;
use Bisarca\Graph\Vertex\VertexInterface;

trait DegreeTrait
{
    /**
     * Gets the edges set.
     *
     * @return EdgeSet
     */
    abstract public function getEdgeSet(): EdgeSet;

    /**
     * Gets the vertices set.
     *
     * @return VertexSet
     */
    abstract public function getVertexSet(): VertexSet;

    /**
     * Gets vertex degree.
     *
     * @param VertexInterface $vertex
     *
     * @return int
     */
    public function getVertexDegree(VertexInterface $vertex): int
    {
        return $this->getVertexInDegree($vertex) + $this->getVertexOutDegree($vertex);
    }

    /**
     * Gets vertex in degree.
     *
     * @param VertexInterface $vertex
     *
     * @return int
     */
    public function getVertexInDegree(VertexInterface $vertex): int
    {
        $counter = 0;

        foreach ($this->getEdgeSet() as $edge) {
            $counter += $edge->hasVertexEnd() && $vertex === $edge->getVertexEnd();
        }

        return $counter;
    }

    /**
     * Gets vertex out degree.
     *
     * @param VertexInterface $vertex
     *
     * @return int
     */
    public function getVertexOutDegree(VertexInterface $vertex): int
    {
        $counter = 0;

        foreach ($this->getEdgeSet() as $edge) {
            $counter += $edge->hasVertexStart() && $vertex === $edge->getVertexStart();
        }

        return $counter;
    }

    /**
     * Gets maximum degree.
     *
     * @return int
     */
    public function getMaxDegree(): int
    {
        $maximum = 0;

        foreach ($this->getVertexSet() as $vertex) {
            $maximum = max($maximum, $this->getVertexDegree($vertex));
        }

        return $maximum;
    }

    /**
     * Gets minimum degree.
     *
     * @return int
     */
    public function getMinDegree(): int
    {
        $minimum = PHP_INT_MAX;

        foreach ($this->getVertexSet() as $vertex) {
            $minimum = min($minimum, $this->getVertexDegree($vertex));
        }

        return $minimum;
    }

    /**
     * Checks if vertex is isolated.
     *
     * @param VertexInterface $vertex
     *
     * @return bool
     */
    public function isIsolatedVertex(VertexInterface $vertex): bool
    {
        return 0 === $this->getVertexDegree($vertex);
    }

    /**
     * Checks if vertex is a leaf.
     *
     * @param VertexInterface $vertex
     *
     * @return bool
     */
    public function isLeafVertex(VertexInterface $vertex): bool
    {
        return 1 === $this->getVertexDegree($vertex);
    }

    /**
     * Checks if vertex is dominating.
     *
     * @param VertexInterface $vertex
     *
     * @return bool
     */
    public function isDominatingVertex(VertexInterface $vertex): bool
    {
        return (count($this->getVertexSet()) - 1) === $this->getVertexDegree($vertex);
    }
}