概要
引数として与えた複数の数の中で最小の数を返します。
構文
Math.min([value1[,
value2[, ...]]])
引数
value1, value2, ...
- 複数の数値(数字)
詳細
min
は Math
オブジェクトの静的なメソッドなので、自ら生成した Math
オブジェクトのメソッドとしてではなく、常に、Math.min()
として使用するようにしてください。
引数が与えられなかった場合、その結果は、Infinity
になります。
1 つでも数値に変換できないパラメータが渡された場合、結果は、NaN になります。
例
例:Math.min
の使用
以下の関数は、変数 x
と y
を評価します。
function getMin(x, y) { return Math.min(x, y); }
getMin
に 10 と 20 を渡した場合、このメソッドは、10 を返します。 -10 と -20 を渡した場合は、-20 を返します。
Example: Clipping a value with Math.min
Math.min
は、しきい値以下に値をクリップするために用いられる事があります。
var x = f(foo); if (x > boundary) { x = boundary; }
上記コードは Math.min
を用いて次のように書き換える事が出来ます。
var x = Math.min( f(foo), boundary );
Math.max
を用いれば、反対に、しきい値以上に値をクリップする事が出来ます。