Stage 0 Draft / October 10, 2024

Math.clamp

Introduction

Math.clamp() constrains a value between an upper and lower bound.

1 Math.clamp ( value, min, max )

This function returns the Number value that is the result of constraining number between the bounds defined by min and max.

  1. If value is not a Number, throw a TypeError exception.
  2. If min is not a Number, throw a TypeError exception.
  3. If min is NaN, throw a RangeError exception.
  4. If max is not a Number, throw a TypeError exception.
  5. If max is NaN, throw a RangeError exception.
  6. If min ≥ max, throw a RangeError exception.
  7. If value is NaN, return NaN.
  8. If value is -0𝔽 and min is +0𝔽, return min.
  9. If value is +0𝔽 and min is -0𝔽, return min.
  10. If value < min, return min.
  11. If value is -0𝔽 and max is +0𝔽, return max.
  12. If value is +0𝔽 and max is -0𝔽, return max.
  13. If value > max, return max.
  14. Return value.

A Copyright & Software License

Copyright Notice

© 2024 Oliver Medhurst, Richie Bendall

Software License

All Software contained in this document ("Software") is protected by copyright and is being made available under the "BSD License", included below. This Software may be subject to third party rights (rights from parties other than Ecma International), including patent rights, and no licenses under such third party rights are granted under this license even if the third party concerned is a member of Ecma International. SEE THE ECMA CODE OF CONDUCT IN PATENT MATTERS AVAILABLE AT https://ecma-international.org/memento/codeofconduct.htm FOR INFORMATION REGARDING THE LICENSING OF PATENT CLAIMS THAT ARE REQUIRED TO IMPLEMENT ECMA INTERNATIONAL STANDARDS.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the authors nor Ecma International may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE ECMA INTERNATIONAL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ECMA INTERNATIONAL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.