Jose\Util\BigInteger

Complexity

Total Complexity

21

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	1

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	createFromGMPResource()	0	6	1
A	createFromBinaryString()	0	7	1
A	createFromDecimalString()	0	6	1
A	createFromDecimal()	0	6	1
A	add()	0	6	1
A	subtract()	0	6	1
A	multiply()	0	6	1
A	toBytes()	0	12	3
A	divide()	0	6	1
A	modPow()	0	6	1
A	mod()	0	6	1
A	modInverse()	0	7	1
A	gcd()	0	6	1
A	compare()	0	4	1
A	equals()	0	4	1
A	isEven()	0	7	1
A	randomInt()	0	6	1

<?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;

use Assert\Assertion;

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

    /**
     * Converts base-10 and binary strings (base-256) to BigIntegers.
     *
     * @param \GMP|string $value
     * @param int         $base
     */
    private function __construct($value, $base)
    {
        if ($value instanceof \GMP) {

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

            $this->value = $value;

It seems like $value of type object<GMP> is incompatible with the declared type resource of property $value.

            return;
        }

        $this->value = gmp_init($value, $base);

It seems like gmp_init($value, $base) of type object<GMP> is incompatible with the declared type resource of property $value.

    }

    /**
     * @param resource $value
     *
     * @return \Jose\Util\BigInteger
     */
    public static function createFromGMPResource($value)
    {
        Assertion::isInstanceOf($value, \GMP::class);

        return new self($value, 0);

$value is of type resource, but the function expects a object<GMP>|string.

    }

    /**
     * @param string $value
     *
     * @return \Jose\Util\BigInteger
     */
    public static function createFromBinaryString($value)
    {
        Assertion::string($value);
        $value = '0x'.bin2hex($value);

        return new self($value, 16);
    }

    /**
     * @param string $value
     *
     * @return \Jose\Util\BigInteger
     */
    public static function createFromDecimalString($value)
    {
        Assertion::string($value);

        return new self($value, 10);
    }

    /**
     * @param int $value
     *
     * @return \Jose\Util\BigInteger
     */
    public static function createFromDecimal($value)
    {
        Assertion::integer($value);

        return new self($value, 10);
    }

    /**
     * Converts a BigInteger to a binary string.
     *
     * @return string
     */
    public function toBytes()
    {
        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));
    }

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

        return self::createFromGMPResource($value);
    }

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

        return self::createFromGMPResource($value);
    }

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

        return self::createFromGMPResource($value);
    }

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

        return self::createFromGMPResource($value);
    }

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

        return self::createFromGMPResource($value);
    }

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

        return self::createFromGMPResource($value);
    }

    /**
     * Calculates modular inverses.
     *
     * @param \Jose\Util\BigInteger $n
     *
     * @return \Jose\Util\BigInteger
     */
    public function modInverse(BigInteger $n)
    {
        $value = gmp_invert($this->value, $n->value);
        Assertion::isInstanceOf($value, \GMP::class);

        return self::createFromGMPResource($value);
    }

    /**
     * Calculates the greatest common denominator.
     *
     * @param BigInteger $x
     *
     * @return BigInteger
     */
    public function gcd(BigInteger $x)
    {
        $value = gmp_gcd($this->value, $x->value);

        return self::createFromGMPResource($value);
    }

    /**
     * Compares two numbers.
     *
     * @param \Jose\Util\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)
    {
        return gmp_cmp($this->value, $y->value);
    }

    /**
     * Check whether two BigIntegers are the same.
     *
     * @param BigInteger $x
     *
     * @return bool
     */
    public function equals(BigInteger $x)
    {
        return 0 === gmp_cmp($this->value, $x->value);
    }

    /**
     * Whether this is an even number.
     *
     * @return bool
     */
    public function isEven()
    {
        $zero = self::createFromDecimal(0);
        $two = self::createFromDecimal(2);

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

    /**
     * Generate a random integer between min and max.
     *
     * @param BigInteger $min
     * @param BigInteger $max
     *
     * @return BigInteger
     */
    public static function randomInt(BigInteger $min, BigInteger $max)
    {
        $value = gmp_random_range($min->value, $max->value);

        return self::createFromGMPResource($value);
    }
}