ExtendedStrings\Strings\Stop

Complexity

Total Complexity

8

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	3
A	fromFrequency()	0	9	2
A	getFrequency()	0	6	1
A	getStringLength()	0	4	1
A	centsToStringLength()	0	4	1

<?php

declare(strict_types = 1);

namespace ExtendedStrings\Strings;

class Stop
{
    private $stringLength;

    /**
     * Stop constructor.
     *
     * @param float $stringLength A "string length": the length of string
     *                            between the stop and the bridge, as a fraction
     *                            of the whole string. A string length of 1.0
     *                            indicates an open string.
     */
    public function __construct(float $stringLength)
    {
        if ($stringLength <= 0 || $stringLength > 1) {
            throw new \InvalidArgumentException(sprintf('Invalid string length: %f', $stringLength));
        }

        $this->stringLength = $stringLength;
    }

    /**
     * Create a Stop instance from a frequency over a string.
     *
     * @param float                                             $frequency
     * @param \ExtendedStrings\Strings\VibratingStringInterface $string
     *
     * @return \ExtendedStrings\Strings\Stop
     */
    public static function fromFrequency(float $frequency, VibratingStringInterface $string): self
    {
        if (Math::isZero($frequency)) {
            throw new \InvalidArgumentException(sprintf('Invalid frequency: %f', $frequency));
        }
        $centsOverString = Cent::frequenciesToCents($string->getFrequency(), $frequency);

        return new self(self::centsToStringLength($centsOverString));
    }

    /**
     * Returns the frequency of the stop (assuming normal stop pressure).
     *
     * @param VibratingStringInterface $string
     *
     * @return float
     */
    public function getFrequency(VibratingStringInterface $string): float
    {
        $centsOverString = Cent::frequenciesToCents($this->stringLength, 1);

        return Cent::centsToFrequency($centsOverString, $string->getFrequency());
    }

    /**
     * Returns the string length for the stop.
     *
     * @see Stop::__construct() for a definition of "string length"
     *
     * @return float
     */
    public function getStringLength(): float
    {
        return $this->stringLength;
    }

    /**
     * Convert a number of cents over a string to a string length.
     *
     * @see Stop::__construct() for a definition of "string length"
     *
     * @param float $cents The number of cents between the open string's pitch
     *                     and the stopped pitch.
     *
     * @return float
     */
    private static function centsToStringLength(float $cents): float
    {
        return 1 / pow(2, $cents / 1200);
    }
}