Tdn\PhpTypes\Math\Library\Gmp

Complexity

Total Complexity

21

Size/Duplication

Total Lines	268
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	createInvalidLibraryException()	0	6	1
A	add()	0	4	1
A	subtract()	0	4	1
A	multiply()	0	4	1
A	divide()	0	4	1
A	compare()	0	4	1
A	modulus()	0	4	1
A	power()	0	4	1
A	squareRoot()	0	4	1
A	absolute()	0	4	1
A	negate()	0	4	1
A	factorial()	0	4	1
A	gcd()	0	4	1
A	root()	0	6	1
A	nextPrime()	0	4	1
A	isPrime()	0	4	1
A	isPerfectSquare()	0	4	1
A	gamma()	0	4	1
A	logGamma()	0	4	1
A	supportsOperationType()	0	5	1
A	isEnabled()	0	4	1

<?php

namespace Tdn\PhpTypes\Math\Library;

/**
 * Class Gmp.
 */
class Gmp implements MathLibraryInterface
{
    /**
     * Add two arbitrary precision numbers.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     * @param int    $precision
     *
     * @return string
     */
    public function add(string $leftOperand, string $rightOperand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_add($leftOperand, $rightOperand));
    }

    /**
     * Subtract two arbitrary precision numbers.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     * @param int    $precision
     *
     * @return string
     */
    public function subtract(string $leftOperand, string $rightOperand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_sub($leftOperand, $rightOperand));
    }

    /**
     * Multiply two arbitrary precision numbers.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     * @param int    $precision
     *
     * @return string
     */
    public function multiply(string $leftOperand, string $rightOperand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_mul($leftOperand, $rightOperand));
    }

    /**
     * Divide two arbitrary precision numbers.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     * @param int    $precision
     *
     * @return string
     */
    public function divide(string $leftOperand, string $rightOperand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_div($leftOperand, $rightOperand));
    }

    /**
     * Compare two arbitrary precision numbers.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     * @param int    $precision
     *
     * @return string
     */
    public function compare(string $leftOperand, string $rightOperand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_cmp($leftOperand, $rightOperand));
    }

    /**
     * Get modulus of an arbitrary precision number.
     *
     * @param string $operand
     * @param string $modulus
     * @param int    $precision
     *
     * @return string
     */
    public function modulus(string $operand, string $modulus, int $precision = 0): string
    {
        return \gmp_strval(\gmp_mod($operand, $modulus));
    }

    /**
     * Raise an arbitrary precision number to another.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     * @param int    $precision
     *
     * @return string
     */
    public function power(string $leftOperand, string $rightOperand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_pow($leftOperand, (int) $rightOperand));
    }

    /**
     * Get the square root of an arbitrary precision number.
     *
     * @param string $operand
     * @param int    $precision
     *
     * @return string
     */
    public function squareRoot(string $operand, int $precision = 0): string
    {
        return \gmp_strval(\gmp_sqrt($operand));
    }

    /**
     * Returns absolute value of operand.
     *
     * @param string $operand
     *
     * @return string
     */
    public function absolute(string $operand): string
    {
        return \gmp_strval(\gmp_abs($operand));
    }

    /**
     * Negates a number. Opposite of absolute/abs.
     *
     * @param string $operand
     *
     * @return string
     */
    public function negate(string $operand): string
    {
        return \gmp_strval(\gmp_neg($operand));
    }

    /**
     * Returns the factorial of operand.
     *
     * @param string $operand
     *
     * @return string
     */
    public function factorial(string $operand): string
    {
        return \gmp_strval(\gmp_fact($operand));
    }

    /**
     * Greatest common divisor.
     *
     * @param string $leftOperand
     * @param string $rightOperand
     *
     * @return string
     */
    public function gcd(string $leftOperand, string $rightOperand): string
    {
        return \gmp_strval(\gmp_gcd($leftOperand, $rightOperand));
    }

    /**
     * Calculates to the nth root.
     *
     * @param string $operand
     * @param int    $nth
     *
     * @return string
     */
    public function root(string $operand, int $nth): string
    {
        $operand = \gmp_init($operand, 10);

        return \gmp_strval(\gmp_root($operand, $nth));
    }

    /**
     * Gets the next prime after operand.
     *
     * @param string $operand
     *
     * @return string
     */
    public function nextPrime(string $operand): string
    {
        return \gmp_strval(\gmp_nextprime($operand));
    }

    /**
     * @param string $operand
     * @param int    $reps
     *
     * @return bool
     */
    public function isPrime(string $operand, int $reps = 10): bool
    {
        return 0 < \gmp_prob_prime($operand, $reps);
    }

    /**
     * Checks if operand is perfect square.
     *
     * @param string $operand
     * @param int    $precision
     *
     * @return bool
     */
    public function isPerfectSquare(string $operand, int $precision = 0): bool
    {
        return \gmp_perfect_square($operand);
    }

    /**
     * The gamma function.
     *
     * @param string $operand
     *
     * @return string
     */
    public function gamma(string $operand): string
    {
        throw $this->createInvalidLibraryException(__FUNCTION__);
    }

    /**
     * The log-gamma function.
     *
     * @param string $operand
     *
     * @return string
     */
    public function logGamma(string $operand): string
    {
        throw $this->createInvalidLibraryException(__FUNCTION__);
    }

    /**
     * @param string $type
     *
     * @return bool
     */
    public function supportsOperationType(string $type): bool
    {
        //Supports only int.
        return $type !== self::TYPE_FLOAT;
    }

    /**
     * @return bool
     */
    public function isEnabled(): bool
    {
        return extension_loaded('gmp');
    }

    /**
     * @param string $methodName
     *
     * @return \RuntimeException
     */
    private function createInvalidLibraryException(string $methodName): \RuntimeException
    {
        return new \RuntimeException(
            sprintf('Not a valid library for %s.', $methodName)
        );
    }
}