@lijuhong1981/jsmath 1.0.0 → 1.0.2

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/index.js

@@ -12,14 +12,11 @@ import {
     DEGREES_PER_RADIAN,
     RADIANS_PER_ARCSECOND
 } from "./src/Constant.js";
-import clampToRange from "./src/clampToRange.js";
-import clampToLongitudeRange from "./src/clampToLongitudeRange.js";
-import clampToLatitudeRange from "./src/clampToLatitudeRange.js";
+import clamp from "./src/clamp.js";
 import convertToRange from "./src/convertToRange.js";
-import convertToLongitudeRange from "./src/convertToLongitudeRange.js";
-import convertToLatitudeRange from "./src/convertToLatitudeRange.js";
 import convertToDegreesRound from "./src/convertToDegreesRound.js";
 import convertToRadiansRound from "./src/convertToRadiansRound.js";
+import isBetween from "./src/isBetween.js";
 import percentInRange from "./src/percentInRange.js";
 import percentToRange from "./src/percentToRange.js";
 import randomInteger from "./src/randomInteger.js";
@@ -38,14 +35,11 @@ export {
     RADIANS_PER_DEGREE,
     DEGREES_PER_RADIAN,
     RADIANS_PER_ARCSECOND,
-    clampToRange,
-    clampToLongitudeRange,
-    clampToLatitudeRange,
+    clamp,
     convertToRange,
-    convertToLongitudeRange,
-    convertToLatitudeRange,
     convertToDegreesRound,
     convertToRadiansRound,
+    isBetween,
     percentInRange,
     percentToRange,
     randomInteger,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lijuhong1981/jsmath",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "index.js",
   "module": "index.js",

package/src/clamp.js

@@ -0,0 +1,17 @@
+import Check from "@lijuhong1981/jscheck";
+
+/**
+ * 将一个数值约束在两个数值之间
+ * @param {Number} value 需要约束的数值
+ * @param {Number} rangeMinimum 较小数
+ * @param {Number} rangeMaximum 较大数
+ * @returns {Number} 约束后的数值
+ */
+function clamp(value, rangeMinimum, rangeMaximum) {
+    Check.typeOf.number('value', value);
+    Check.typeOf.number('rangeMinimum', rangeMinimum);
+    Check.typeOf.number('rangeMaximum', rangeMaximum);
+    return value < rangeMinimum ? rangeMinimum : value > rangeMaximum ? rangeMaximum : value;
+};
+
+export default clamp;

package/src/convertToDegreesRound.js

@@ -1,7 +1,13 @@
 import convertToRange from "./convertToRange.js";
 
+/**
+ * 转换一个角度至一个圆周范围内
+ * @param {Number} degrees 需要换行的角度
+ * @param {Number} minValue 起始角度，默认0
+ * @returns {Number} 转换后的角度
+ */
 function convertToDegreesRound(degrees, minValue = 0) {
     return convertToRange(degrees, minValue, minValue + 360);
-}
+};
 
 export default convertToDegreesRound;

package/src/convertToRadiansRound.js

@@ -1,8 +1,14 @@
 import convertToRange from "./convertToRange.js";
 import { TWO_PI } from "./Constant.js";
 
+/**
+ * 转换一个弧度至一个圆周范围内
+ * @param {Number} radians 需要转换的弧度
+ * @param {Number} minValue 圆周起始弧度，默认0
+ * @returns {Number} 转换后的弧度
+ */
 function convertToRadiansRound(radians, minValue = 0) {
     return convertToRange(radians, minValue, minValue + TWO_PI);
-}
+};
 
 export default convertToRadiansRound;

package/src/convertToRange.js

@@ -1,18 +1,26 @@
 import Check from "@lijuhong1981/jscheck";
 
-function convertToRange(value, min, max) {
-    Check.typeOf.number("value", value);
-    Check.typeOf.number("min", min);
-    Check.typeOf.number("max", max);
+/**
+ * 将一个数值转换至两个数值范围内
+ * 如不在范围内则累加或累减范围长度，直至落在范围内
+ * @param {Number} 需要转换的数值
+ * @param {Number} 较小数
+ * @param {Number} 较大数
+ * @returns {Number} 转换后的数值
+ */
+function convertToRange(value, rangeMinimum, rangeMaximum) {
+    Check.typeOf.number('value', value);
+    Check.typeOf.number('rangeMinimum', rangeMinimum);
+    Check.typeOf.number('rangeMaximum', rangeMaximum);
 
-    const length = max - min;
-    if (value < min) {
+    const length = rangeMaximum - rangeMinimum;
+    if (value < rangeMinimum) {
         value += length;
-        while (value < min)
+        while (value < rangeMinimum)
             value += length;
-    } else if (value > max) {
+    } else if (value > rangeMaximum) {
         value -= length;
-        while (value > max)
+        while (value > rangeMaximum)
             value -= length;
     }
     return value;

package/src/isBetween.js

@@ -0,0 +1,23 @@
+import Check from "@lijuhong1981/jscheck";
+
+/**
+ * 判断一个数值是否在两个数值之间
+ * @param {Number} value 需要判断的数值
+ * @param {Number} rangeMinimum 较小数
+ * @param {Number} rangeMaximum 较大数
+ * @param {Boolean} equalsMinimum 可否等于较小数，默认true
+ * @param {Boolean} equalsMaximum 可否等于较大数，默认true
+ * @returns {Boolean} 判断结果
+ */
+function isBetween(value, rangeMinimum, rangeMaximum, equalsMinimum = true, equalsMaximum = true) {
+    Check.typeOf.number('value', value);
+    Check.typeOf.number('rangeMinimum', rangeMinimum);
+    Check.typeOf.number('rangeMaximum', rangeMaximum);
+    if (equalsMinimum ? value < rangeMinimum : value <= rangeMinimum)
+        return false;
+    if (equalsMaximum ? value > rangeMaximum : value >= rangeMaximum)
+        return false;
+    return true;
+};
+
+export default isBetween;

package/src/percentInRange.js

@@ -1,10 +1,22 @@
-import clampToRange from "./clampToRange.js";
+import Check from "@lijuhong1981/jscheck";
+import clamp from "./clamp.js";
 
-function percentInRange(value, rangeMinimum, rangeMaximum, clamp = false) {
-    let scalar = (value - rangeMinimum) / (rangeMaximum - rangeMinimum);
-    if (clamp)
-        scalar = clampToRange(scalar, 0, 1);
-    return scalar;
+/**
+ * 计算一个数值在两个数值范围内的百分比
+ * @param {Number} value 需要计算的数值
+ * @param {Number} rangeMinimum 较小数
+ * @param {Number} rangeMaximum 较大数
+ * @param {Boolean} needClamp 是否需要约束至0到1之间，默认false
+ * @returns {Number} 百分比
+ */
+function percentInRange(value, rangeMinimum, rangeMaximum, needClamp = false) {
+    Check.typeOf.number('value', value);
+    Check.typeOf.number('rangeMinimum', rangeMinimum);
+    Check.typeOf.number('rangeMaximum', rangeMaximum);
+    let percent = (value - rangeMinimum) / (rangeMaximum - rangeMinimum);
+    if (needClamp)
+        percent = clamp(percent, 0, 1);
+    return percent;
 };
 
 export default percentInRange;

package/src/percentToRange.js

@@ -1,8 +1,20 @@
-import clampToRange from "./clampToRange.js";
+import Check from "@lijuhong1981/jscheck";
+import clamp from "./clamp.js";
 
-function percentToRange(percent, rangeMinimum, rangeMaximum, clamp = false) {
-    if (clamp)
-        percent = clampToRange(percent, 0, 1);
+/**
+ * 根据百分比计算在两个数值之间的数
+ * @param {Number} percent 百分比
+ * @param {Number} rangeMinimum 较小数
+ * @param {Number} rangeMaximum 较大数
+ * @param {Boolean} needClamp 是否需要约束至两个数值之间，默认false
+ * @returns {Number} 计算结果
+ */
+function percentToRange(percent, rangeMinimum, rangeMaximum, needClamp = false) {
+    Check.typeOf.number('value', value);
+    Check.typeOf.number('rangeMinimum', rangeMinimum);
+    Check.typeOf.number('rangeMaximum', rangeMaximum);
+    if (needClamp)
+        percent = clamp(percent, 0, 1);
     return rangeMinimum + (rangeMaximum - rangeMinimum) * percent;
 };
 

package/src/randomInteger.js

@@ -1,7 +1,13 @@
 import randomNumber from "./randomNumber.js";
 
-function randomInteger(min = 0, max = Number.MAX_SAFE_INTEGER - 1) {
-    return Math.floor(randomNumber(min, max + 1));
+/**
+ * 产生一个随机整数，可指定随机范围
+ * @param {Number} rangeMinimum 最小整数，默认0
+ * @param {Number} rangeMaximum 最大整数，默认Number.MAX_SAFE_INTEGER
+ * @returns {Integer} 生成的随机整数
+ */
+function randomInteger(rangeMinimum = 0, rangeMaximum = Number.MAX_SAFE_INTEGER - 1) {
+    return Math.floor(randomNumber(rangeMinimum, rangeMaximum + 1));
 };
 
 export default randomInteger;

package/src/randomNumber.js

@@ -1,5 +1,11 @@
-function randomNumber(min = 0, max = Number.MAX_SAFE_INTEGER) {
-    return Math.random() * (max - min) + min;
+/**
+ * 产生一个随机数，可指定随机范围
+ * @param {Number} rangeMinimum 最小数，默认0
+ * @param {Number} rangeMaximum 最大数，默认Number.MAX_SAFE_INTEGER
+ * @returns {Number} 生成的随机数
+ */
+function randomNumber(rangeMinimum = 0, rangeMaximum = Number.MAX_SAFE_INTEGER) {
+    return Math.random() * (rangeMaximum - rangeMinimum) + rangeMinimum;
 };
 
 export default randomNumber;

package/src/clampToLatitudeRange.js

@@ -1,11 +0,0 @@
-import clampToRange from "./clampToRange.js";
-import { PI_OVER_TWO } from "./Constant.js";
-
-function clampToLatitudeRange(latitude, degrees = true) {
-    if (degrees)
-        return clampToRange(latitude, -90, 90);
-    else
-        return clampToRange(latitude, -PI_OVER_TWO, PI_OVER_TWO);
-};
-
-export default clampToLatitudeRange;

package/src/clampToLongitudeRange.js

@@ -1,10 +0,0 @@
-import clampToRange from "./clampToRange.js";
-
-function clampToLongitudeRange(longitude, degrees = true) {
-    if (degrees)
-        return clampToRange(longitude, -180, 180);
-    else
-        return clampToRange(longitude, -Math.PI, Math.PI);
-};
-
-export default clampToLongitudeRange;

package/src/clampToRange.js

@@ -1,5 +0,0 @@
-function clampToRange(value, min, max) {
-    return value < min ? min : value > max ? max : value;
-};
-
-export default clampToRange;

package/src/convertToLatitudeRange.js

@@ -1,24 +0,0 @@
-import { PI_OVER_TWO } from "./Constant.js";
-
-function convertToLatitudeRange(latitude, degrees = true) {
-    if (degrees) {
-        while (latitude > 90 || latitude < -90) {
-            if (latitude > 90) {
-                latitude = 180 - latitude;
-            } else if (latitude < -90) {
-                latitude = -180 - latitude;
-            }
-        }
-    } else {
-        while (latitude > PI_OVER_TWO || latitude < -PI_OVER_TWO) {
-            if (latitude > PI_OVER_TWO) {
-                latitude = Math.PI - latitude;
-            } else if (latitude < -PI_OVER_TWO) {
-                latitude = -Math.PI - latitude;
-            }
-        }
-    }
-    return latitude;
-};
-
-export default convertToLatitudeRange;

package/src/convertToLongitudeRange.js

@@ -1,10 +0,0 @@
-import convertToRange from "./convertToRange.js";
-
-function convertToLongitudeRange(longitude, degrees = true) {
-    if (degrees)
-        return convertToRange(longitude, -180, 180);
-    else
-        return convertToRange(longitude, -Math.PI, Math.PI);
-};
-
-export default convertToLongitudeRange;