interface CalculatorInterface
A calculator performs arithmetic operations on numbers
@psalm-immutable
Hierarchy
- interface \Ramsey\Uuid\Math\CalculatorInterface
Expanded class hierarchy of CalculatorInterface
All classes that implement CalculatorInterface
5 files declare their use of CalculatorInterface
- FeatureSet.php in vendor/
ramsey/ uuid/ src/ FeatureSet.php - GenericNumberConverter.php in vendor/
ramsey/ uuid/ src/ Converter/ Number/ GenericNumberConverter.php - GenericTimeConverter.php in vendor/
ramsey/ uuid/ src/ Converter/ Time/ GenericTimeConverter.php - PhpTimeConverter.php in vendor/
ramsey/ uuid/ src/ Converter/ Time/ PhpTimeConverter.php - UnixTimeConverter.php in vendor/
ramsey/ uuid/ src/ Converter/ Time/ UnixTimeConverter.php
File
-
vendor/
ramsey/ uuid/ src/ Math/ CalculatorInterface.php, line 26
Namespace
Ramsey\Uuid\MathView source
interface CalculatorInterface {
/**
* Returns the sum of all the provided parameters
*
* @param NumberInterface $augend The first addend (the integer being added to)
* @param NumberInterface ...$addends The additional integers to a add to the augend
*
* @return NumberInterface The sum of all the parameters
*/
public function add(NumberInterface $augend, NumberInterface ...$addends) : NumberInterface;
/**
* Returns the difference of all the provided parameters
*
* @param NumberInterface $minuend The integer being subtracted from
* @param NumberInterface ...$subtrahends The integers to subtract from the minuend
*
* @return NumberInterface The difference after subtracting all parameters
*/
public function subtract(NumberInterface $minuend, NumberInterface ...$subtrahends) : NumberInterface;
/**
* Returns the product of all the provided parameters
*
* @param NumberInterface $multiplicand The integer to be multiplied
* @param NumberInterface ...$multipliers The factors by which to multiply the multiplicand
*
* @return NumberInterface The product of multiplying all the provided parameters
*/
public function multiply(NumberInterface $multiplicand, NumberInterface ...$multipliers) : NumberInterface;
/**
* Returns the quotient of the provided parameters divided left-to-right
*
* @param int $roundingMode The RoundingMode constant to use for this operation
* @param int $scale The scale to use for this operation
* @param NumberInterface $dividend The integer to be divided
* @param NumberInterface ...$divisors The integers to divide $dividend by, in
* the order in which the division operations should take place
* (left-to-right)
*
* @return NumberInterface The quotient of dividing the provided parameters left-to-right
*/
public function divide(int $roundingMode, int $scale, NumberInterface $dividend, NumberInterface ...$divisors) : NumberInterface;
/**
* Converts a value from an arbitrary base to a base-10 integer value
*
* @param string $value The value to convert
* @param int $base The base to convert from (i.e., 2, 16, 32, etc.)
*
* @return IntegerObject The base-10 integer value of the converted value
*/
public function fromBase(string $value, int $base) : IntegerObject;
/**
* Converts a base-10 integer value to an arbitrary base
*
* @param IntegerObject $value The integer value to convert
* @param int $base The base to convert to (i.e., 2, 16, 32, etc.)
*
* @return string The value represented in the specified base
*/
public function toBase(IntegerObject $value, int $base) : string;
/**
* Converts an Integer instance to a Hexadecimal instance
*/
public function toHexadecimal(IntegerObject $value) : Hexadecimal;
/**
* Converts a Hexadecimal instance to an Integer instance
*/
public function toInteger(Hexadecimal $value) : IntegerObject;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
CalculatorInterface::add | public | function | Returns the sum of all the provided parameters | 1 |
CalculatorInterface::divide | public | function | Returns the quotient of the provided parameters divided left-to-right | 1 |
CalculatorInterface::fromBase | public | function | Converts a value from an arbitrary base to a base-10 integer value | 1 |
CalculatorInterface::multiply | public | function | Returns the product of all the provided parameters | 1 |
CalculatorInterface::subtract | public | function | Returns the difference of all the provided parameters | 1 |
CalculatorInterface::toBase | public | function | Converts a base-10 integer value to an arbitrary base | 1 |
CalculatorInterface::toHexadecimal | public | function | Converts an Integer instance to a Hexadecimal instance | 1 |
CalculatorInterface::toInteger | public | function | Converts a Hexadecimal instance to an Integer instance | 1 |