Jose\Util\BigInteger

Complexity

Total Complexity

28

Size/Duplication

Total Lines	304
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	1

24 Methods

Rating	Name	Duplication	Size	Complexity
A	toBytes()	0	12	3
A	compare()	0	4	1
A	equals()	0	4	1
A	random()	0	6	1
A	gcd()	0	4	1
A	lowerThan()	0	4	1
A	lowerOrEqualThan()	0	4	1
A	greaterThan()	0	4	1
A	greaterOrEqualThan()	0	4	1
A	isEven()	0	7	1
A	isOdd()	0	4	1
A	__construct()	0	4	1
A	createFromGMPResource()	0	4	1
A	createFromBinaryString()	0	6	1
A	createFromDecimalString()	0	6	1
A	createFromDecimal()	0	6	1
A	toInteger()	0	10	2
A	add()	0	6	1
A	subtract()	0	6	1
A	multiply()	0	6	1
A	divide()	0	6	1
A	modPow()	0	6	1
A	mod()	0	6	1
A	modInverse()	0	9	2

<?php

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2016 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace Jose\Util;

final class BigInteger
{
    /**
     * Holds the BigInteger's value.
     *
     * @var \GMP
     */
    private $value;

    /**
     * BigInteger constructor.
     *
     * @param \GMP $value
     */
    private function __construct(\GMP $value)
    {
        $this->value = $value;
    }

    /**
     * @param \GMP $value
     *
     * @return BigInteger
     */
    public static function createFromGMPResource(\GMP $value): BigInteger
    {
        return new self($value);
    }

    /**
     * @param string $value
     *
     * @return BigInteger
     */
    public static function createFromBinaryString(string $value): BigInteger
    {
        $value = gmp_init('0x'.bin2hex($value), 16);

        return new self($value);
    }

    /**
     * @param string $value
     *
     * @return BigInteger
     */
    public static function createFromDecimalString(string $value): BigInteger
    {
        $value = gmp_init($value, 10);

        return new self($value);
    }

    /**
     * @param int $value
     *
     * @return BigInteger
     */
    public static function createFromDecimal(int $value): BigInteger
    {
        $value = gmp_init($value, 10);

        return new self($value);
    }

    /**
     * Converts a BigInteger to a binary string.
     *
     * @return string
     */
    public function toBytes(): string
    {
        if (gmp_cmp($this->value, gmp_init(0)) === 0) {
            return '';
        }

        $temp = gmp_strval(gmp_abs($this->value), 16);
        $temp = mb_strlen($temp, '8bit') & 1 ? '0'.$temp : $temp;
        $temp = hex2bin($temp);

        return ltrim($temp, chr(0));
    }

    /**
     * Converts a BigInteger to a binary string.
     *
     * @return int
     */
    public function toInteger(): int
    {
        if (gmp_cmp($this->value, gmp_init(0)) === 0) {
            return '';
        }

        $temp = gmp_strval(gmp_abs($this->value), 10);

        return (int) $temp;
    }

    /**
     * Adds two BigIntegers.
     *
     *  @param BigInteger $y
     *
     *  @return BigInteger
     */
    public function add(BigInteger $y): BigInteger
    {
        $value = gmp_add($this->value, $y->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Subtracts two BigIntegers.
     *
     *  @param BigInteger $y
     *
     *  @return BigInteger
     */
    public function subtract(BigInteger $y): BigInteger
    {
        $value = gmp_sub($this->value, $y->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Multiplies two BigIntegers.
     *
     * @param BigInteger $x
     *
     *  @return BigInteger
     */
    public function multiply(BigInteger $x): BigInteger
    {
        $value = gmp_mul($this->value, $x->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Divides two BigIntegers.
     *
     * @param BigInteger $x
     *
     *  @return BigInteger
     */
    public function divide(BigInteger $x): BigInteger
    {
        $value = gmp_div($this->value, $x->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Performs modular exponentiation.
     *
     * @param BigInteger $e
     * @param BigInteger $n
     *
     * @return BigInteger
     */
    public function modPow(BigInteger $e, BigInteger $n): BigInteger
    {
        $value = gmp_powm($this->value, $e->value, $n->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Performs modular exponentiation.
     *
     * @param BigInteger $d
     *
     * @return BigInteger
     */
    public function mod(BigInteger $d): BigInteger
    {
        $value = gmp_mod($this->value, $d->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Calculates modular inverses.
     *
     * @param BigInteger $n
     *
     * @return BigInteger
     */
    public function modInverse(BigInteger $n): BigInteger
    {
        $value = gmp_invert($this->value, $n->value);
        if (!$value instanceof \GMP) {

The class GMP does not exist. Did you forget a USE statement, or did you not list all dependencies?

            throw new \InvalidArgumentException();
        }

        return self::createFromGMPResource($value);
    }

    /**
     * Compares two numbers.
     *
     * @param BigInteger $y
     *
     * @return int < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
     */
    public function compare(BigInteger $y): int
    {
        return gmp_cmp($this->value, $y->value);
    }

    /**
     * @param BigInteger $y
     *
     * @return bool
     */
    public function equals(BigInteger $y): bool
    {
        return 0 === $this->compare($y);
    }

    /**
     * @param BigInteger $y
     *
     * @return BigInteger
     */
    public static function random(BigInteger $y): BigInteger
    {
        $zero = BigInteger::createFromDecimal(0);

As per coding style, self should be used for accessing local static members.

        return BigInteger::createFromGMPResource(gmp_random_range($zero->value, $y->value));

As per coding style, self should be used for accessing local static members.

    }

    /**
     * @param BigInteger $y
     *
     * @return BigInteger
     */
    public function gcd(BigInteger $y): BigInteger
    {
        return BigInteger::createFromGMPResource(gmp_gcd($this->value, $y->value));

As per coding style, self should be used for accessing local static members.

    }

    /**
     * @param BigInteger $y
     *
     * @return bool
     */
    public function lowerThan(BigInteger $y): bool
    {
        return 0 > $this->compare($y);
    }

    /**
     * @param BigInteger $y
     *
     * @return bool
     */
    public function lowerOrEqualThan(BigInteger $y): bool
    {
        return 0 >= $this->compare($y);
    }

    /**
     * @param BigInteger $y
     *
     * @return bool
     */
    public function greaterThan(BigInteger $y): bool
    {
        return 0 < $this->compare($y);
    }

    /**
     * @param BigInteger $y
     *
     * @return bool
     */
    public function greaterOrEqualThan(BigInteger $y): bool
    {
        return 0 <= $this->compare($y);
    }

    /**
     * @return bool
     */
    public function isEven(): bool
    {
        $zero = BigInteger::createFromDecimal(0);

As per coding style, self should be used for accessing local static members.

        $two  = BigInteger::createFromDecimal(2);

As per coding style, self should be used for accessing local static members.

        return $this->mod($two)->equals($zero);
    }

    /**
     * @return bool
     */
    public function isOdd(): bool
    {
        return !$this->isEven();
    }
}