Added Math.sol docstrings. (#1423)
This commit is contained in:
@ -5,14 +5,25 @@ pragma solidity ^0.4.24;
|
|||||||
* @dev Assorted math operations
|
* @dev Assorted math operations
|
||||||
*/
|
*/
|
||||||
library Math {
|
library Math {
|
||||||
|
/**
|
||||||
|
* @dev Returns the largest of two numbers.
|
||||||
|
*/
|
||||||
function max(uint256 a, uint256 b) internal pure returns (uint256) {
|
function max(uint256 a, uint256 b) internal pure returns (uint256) {
|
||||||
return a >= b ? a : b;
|
return a >= b ? a : b;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dev Returns the smallest of two numbers.
|
||||||
|
*/
|
||||||
function min(uint256 a, uint256 b) internal pure returns (uint256) {
|
function min(uint256 a, uint256 b) internal pure returns (uint256) {
|
||||||
return a < b ? a : b;
|
return a < b ? a : b;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dev Calculates the average of two numbers. Since these are integers,
|
||||||
|
* averages of an even and odd number cannot be represented, and will be
|
||||||
|
* rounded down.
|
||||||
|
*/
|
||||||
function average(uint256 a, uint256 b) internal pure returns (uint256) {
|
function average(uint256 a, uint256 b) internal pure returns (uint256) {
|
||||||
// (a + b) / 2 can overflow, so we distribute
|
// (a + b) / 2 can overflow, so we distribute
|
||||||
return (a / 2) + (b / 2) + ((a % 2 + b % 2) / 2);
|
return (a / 2) + (b / 2) + ((a % 2 + b % 2) / 2);
|
||||||
|
|||||||
Reference in New Issue
Block a user