MathUtils (noark-core 3.3.2.Final API)

java.lang.Object
- xyz.noark.core.util.MathUtils

```
public class MathUtils
extends java.lang.Object
```
数学计算相关的工具类库.

从以下版本开始:

3.2

作者:

小流氓(176543888@qq.com)

字段概要

字段
限定符和类型字段和说明

static double HUNDRED
百

static double MILLION
百万

static double ONE
一

static double TEN_THOUSAND
万

static double THOUSAND
千

字段
限定符和类型	字段和说明
`static double`	`HUNDRED` 百
`static double`	`MILLION` 百万
`static double`	`ONE` 一
`static double`	`TEN_THOUSAND` 万
`static double`	`THOUSAND` 千

构造器概要

构造器
构造器和说明

MathUtils()

构造器
构造器和说明
`MathUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static int`	`addExact(int x, int y)` 计算两个参数的和，如果相加出现溢出那就返回`int`的最大值.
`static long`	`addExact(long x, long y)` 计算两个参数的和，如果相加出现溢出那就返回`long`的最大值.
`static boolean`	`adjacent(int x1, int y1, int x2, int y2)` 判定两点(x1,y1)和(x2,y2)是否相邻.
`static boolean`	`adjacent(Point p1, Point p2)` 判定两点P1(x1,y1)和P2(x2,y2)是否相邻.
`static int`	`ceilInt(double a)` 向上取整，并返回int值.
`static long`	`ceilLong(double a)` 向上取整，并返回long值.
`static double`	`distance(double x1, double y1, double x2, double y2)` 计算两点(x1,y1)到(x2,y2)的距离.
`static double`	`distance(int x1, int y1, int x2, int y2)` 计算两点(x1,y1)到(x2,y2)的距离.
`static double`	`distance(Point p1, Point p2)` 计算两点P1(x1,y1)到P2(x2,y2)的距离.
`static int`	`floorInt(double a)` 向下取整，并返回int值.
`static long`	`floorLong(double a)` 向下取整，并返回long值.
`static double`	`formatScale(double value, int newScale)` 格式化小数位数的方法.
`static double`	`formatScale(double value, int newScale, java.math.RoundingMode mode)` 格式化小数位数的方法.
`static float`	`formatScale(float value, int newScale)` 格式化小数位数的方法.
`static float`	`formatScale(float value, int newScale, java.math.RoundingMode mode)` 格式化小数位数的方法.
`static double`	`longToDouble(long value, double ratio)` long类型的数值按比率转化为double类型的值.
`static int`	`multiplyExact(int x, int y)` 计算两个参数的乘积，如果相乘出现溢出那就返回`int`的最大值.
`static long`	`multiplyExact(long x, long y)` 计算两个参数的乘积，如果相乘出现溢出那就返回`long`的最大值.
`static double`	`percentage(long value)` long类型的数值以百分比转化为double类型的值.
`static double`	`permillage(long value)` long类型的数值以千分比转化为double类型的值.
`static <T> java.util.Map<T,java.lang.Long>`	`plunder(java.util.Map<T,java.lang.Long> resources, long max, java.util.Map<T,java.lang.Integer> ratio)` N种资源掠夺最优计算方案.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - ONE
```
public static final double ONE
```
    一
    
    另请参阅:
    
    常量字段值
  - HUNDRED
```
public static final double HUNDRED
```
    百
    
    另请参阅:
    
    常量字段值
  - THOUSAND
```
public static final double THOUSAND
```
    千
    
    另请参阅:
    
    常量字段值
  - TEN_THOUSAND
```
public static final double TEN_THOUSAND
```
    万
    
    另请参阅:
    
    常量字段值
  - MILLION
```
public static final double MILLION
```
    百万
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - MathUtils
```
public MathUtils()
```
- 方法详细资料
  - addExact
```
public static int addExact(int x,
                           int y)
```
    计算两个参数的和，如果相加出现溢出那就返回int的最大值.
    区别于JDK的方法，仅仅认同判定方案，游戏世界，溢出时那就修正一个合理的值，一般调用此方法的游戏逻辑决不能因异常而中断
    
    参数:
    
    x - 第一个参数
    
    y - 第二个参数
    
    返回:
    
    两个参数的和
    
    另请参阅:
    
    Math.addExact(int, int)
  - addExact
```
public static long addExact(long x,
                            long y)
```
    计算两个参数的和，如果相加出现溢出那就返回long的最大值.
    区别于JDK的方法，仅仅认同判定方案，游戏世界，溢出时那就修正一个合理的值，一般调用此方法的游戏逻辑决不能因异常而中断
    
    参数:
    
    x - 第一个参数
    
    y - 第二个参数
    
    返回:
    
    两个参数的和
    
    另请参阅:
    
    Math.addExact(long, long)
  - multiplyExact
```
public static int multiplyExact(int x,
                                int y)
```
    计算两个参数的乘积，如果相乘出现溢出那就返回int的最大值.
    区别于JDK的方法，仅仅认同判定方案，游戏世界，溢出时那就修正一个合理的值，一般调用此方法的游戏逻辑决不能因异常而中断
    
    参数:
    
    x - 第一个参数
    
    y - 第二个参数
    
    返回:
    
    两个参数的乘积
    
    另请参阅:
    
    Math.multiplyExact(int, int)
  - multiplyExact
```
public static long multiplyExact(long x,
                                 long y)
```
    计算两个参数的乘积，如果相乘出现溢出那就返回long的最大值.
    区别于JDK的方法，仅仅认同判定方案，游戏世界，溢出时那就修正一个合理的值，一般调用此方法的游戏逻辑决不能因异常而中断
    
    参数:
    
    x - 第一个参数
    
    y - 第二个参数
    
    返回:
    
    两个参数的乘积
    
    另请参阅:
    
    Math.multiplyExact(long, long)
  - distance
```
public static double distance(int x1,
                              int y1,
                              int x2,
                              int y2)
```
    计算两点(x1,y1)到(x2,y2)的距离.
    Math.sqrt(|x1-x2|² + |y1-y2|²)
    
    参数:
    
    x1 - 坐标X1
    
    y1 - 坐标Y1
    
    x2 - 坐标X2
    
    y2 - 坐标Y2
    
    返回:
    
    两点的距离
  - distance
```
public static double distance(double x1,
                              double y1,
                              double x2,
                              double y2)
```
    计算两点(x1,y1)到(x2,y2)的距离.
    Math.sqrt(|x1-x2|² + |y1-y2|²)
    
    参数:
    
    x1 - 坐标X1
    
    y1 - 坐标Y1
    
    x2 - 坐标X2
    
    y2 - 坐标Y2
    
    返回:
    
    两点的距离
  - distance
```
public static double distance(Point p1,
                              Point p2)
```
    计算两点P1(x1,y1)到P2(x2,y2)的距离.
    Math.sqrt(|x1-x2|² + |y1-y2|²)
    
    参数:
    
    p1 - 坐标1
    
    p2 - 坐标2
    
    返回:
    
    两点的距离
  - adjacent
```
public static boolean adjacent(int x1,
                               int y1,
                               int x2,
                               int y2)
```
    判定两点(x1,y1)和(x2,y2)是否相邻.
    可用于两个AOI是否相邻判定
    
    参数:
    
    x1 - 坐标X1
    
    y1 - 坐标Y1
    
    x2 - 坐标X2
    
    y2 - 坐标Y2
    
    返回:
    
    如果两坐标相邻返回true,否则返回false
  - adjacent
```
public static boolean adjacent(Point p1,
                               Point p2)
```
    判定两点P1(x1,y1)和P2(x2,y2)是否相邻.
    可用于两个AOI是否相邻判定
    
    参数:
    
    p1 - 坐标1
    
    p2 - 坐标2
    
    返回:
    
    如果两坐标相邻返回true,否则返回false
  - floorInt
```
public static int floorInt(double a)
```
    向下取整，并返回int值.
    
    参数:
    
    a - 一个带有小数的数值
    
    返回:
    
    返回向下取整后的int值
  - floorLong
```
public static long floorLong(double a)
```
    向下取整，并返回long值.
    
    参数:
    
    a - 一个带有小数的数值
    
    返回:
    
    返回向下取整后的long值
  - ceilInt
```
public static int ceilInt(double a)
```
    向上取整，并返回int值.
    
    参数:
    
    a - 一个带有小数的数值
    
    返回:
    
    返回向上取整后的int值
  - ceilLong
```
public static long ceilLong(double a)
```
    向上取整，并返回long值.
    
    参数:
    
    a - 一个带有小数的数值
    
    返回:
    
    返回向上取整后的long值
  - formatScale
```
public static float formatScale(float value,
                                int newScale)
```
    格式化小数位数的方法.
    采用了BigDecimal.setScale(int, RoundingMode)方式来保留小数位数
    默认舍入方式为4舍5入, 参考RoundingMode.HALF_UP
    
    参数:
    
    value - 原始值
    
    newScale - 保留小数位数
    
    返回:
    
    返回要被保留指定小数位数的值.
  - formatScale
```
public static float formatScale(float value,
                                int newScale,
                                java.math.RoundingMode mode)
```
    格式化小数位数的方法.
    采用了BigDecimal.setScale(int, RoundingMode)方式来保留小数位数
    
    参数:
    
    value - 原始值
    
    newScale - 保留小数位数
    
    mode - 被保留位数后舍入方式，参考RoundingMode
    
    返回:
    
    返回要被保留指定小数位数的值.
  - formatScale
```
public static double formatScale(double value,
                                 int newScale)
```
    格式化小数位数的方法.
    采用了BigDecimal.setScale(int, RoundingMode)方式来保留小数位数
    默认舍入方式为4舍5入, 参考RoundingMode.HALF_UP
    
    参数:
    
    value - 原始值
    
    newScale - 保留小数位数
    
    返回:
    
    返回要被保留指定小数位数的值.
  - formatScale
```
public static double formatScale(double value,
                                 int newScale,
                                 java.math.RoundingMode mode)
```
    格式化小数位数的方法.
    采用了BigDecimal.setScale(int, RoundingMode)方式来保留小数位数
    
    参数:
    
    value - 原始值
    
    newScale - 保留小数位数
    
    mode - 被保留位数后舍入方式，参考RoundingMode
    
    返回:
    
    返回要被保留指定小数位数的值.
  - plunder
```
public static <T> java.util.Map<T,java.lang.Long> plunder(java.util.Map<T,java.lang.Long> resources,
                                                          long max,
                                                          java.util.Map<T,java.lang.Integer> ratio)
```
    N种资源掠夺最优计算方案.
    有N种资源，尝试抢其他的部分，但各种资源有一定的比例...
    使用场景：SLG的城池掠夺资源计算
    
    类型参数:
    
    T - 资源类型
    
    参数:
    
    resources - N种资源(参数选用LinkedHashMap，就是想按顺序优先扣前面的...)
    
    max - 掠夺的最大值
    
    ratio - 掠夺比例建议：比例总和在100以内
    
    返回:
    
    一种最优的掠夺结果
  - longToDouble
```
public static double longToDouble(long value,
                                  double ratio)
```
    long类型的数值按比率转化为double类型的值.
    由于配置表在转化中精度丢失问题，建议策划配置的是long类型的数值，所以就有了这个转化方法。
    比如：约定XX列为百分比，那配置50，就是50%，等于0.5
    
    参数:
    
    value - long类型的数值
    
    ratio - 比率
    
    返回:
    
    double类型的值
  - permillage
```
public static double permillage(long value)
```
    long类型的数值以千分比转化为double类型的值.
    参考 longToDouble(long, double)
    
    参数:
    
    value - long类型的数值
    
    返回:
    
    double类型的值
  - percentage
```
public static double percentage(long value)
```
    long类型的数值以百分比转化为double类型的值.
    参考 longToDouble(long, double)
    
    参数:
    
    value - long类型的数值
    
    返回:
    
    double类型的值

类 MathUtils

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ONE

HUNDRED

THOUSAND

TEN_THOUSAND

MILLION

构造器详细资料

MathUtils

方法详细资料

addExact

addExact

multiplyExact

multiplyExact

distance

distance

distance

adjacent

adjacent

floorInt

floorLong

ceilInt

ceilLong

formatScale

formatScale

formatScale

formatScale

plunder

longToDouble

permillage

percentage