Java Float Number Clamp clamp(float value, float minimum, float maximum)

Description

Clamps the value to the specified range.

License

Open Source License

Parameter

Parameter	Description
value	The value to clamp.
minimum	The minimum allowed value.
maximum	The maximum allowed value.

Return

A value clamped to the specified range.

Declaration

public static float clamp(float value, float minimum, float maximum) 

Method Source Code

//package com.java2s;
/*//from  w  w  w  . ja  v  a 2  s  .  c o m
 * Copyright (c) 2010 Stephen A. Pratt
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

public class Main {
    /**
     * Clamps the value to the specified range.  The clamp is inclusive
     * such that minimum <= result <= maximum.
     * @param value The value to clamp.
     * @param minimum The minimum allowed value.
     * @param maximum The maximum allowed value.
     * @return A value clamped to the specified range.
     */
    public static float clamp(float value, float minimum, float maximum) {
        return (value < minimum ? minimum : (value > maximum ? maximum : value));
    }

    /**
     * Clamps the value to the specified range.  The clamp is inclusive
     * such that minimum <= result <= maximum.
     * @param value The value to clamp.
     * @param minimum The minimum allowed value.
     * @param maximum The maximum allowed value.
     * @return A value clamped to the specified range.
     */
    public static int clamp(int value, int minimum, int maximum) {
        return (value < minimum ? minimum : (value > maximum ? maximum : value));
    }

    /**
     * Clamps the value to the specified range.  The clamp is inclusive
     * such that minimum <= result <= maximum.
     * @param value The value to clamp.
     * @param minimum The minimum allowed value.
     * @param maximum The maximum allowed value.
     * @return A value clamped to the specified range.
     */
    public static short clamp(short value, short minimum, short maximum) {
        return (value < minimum ? minimum : (value > maximum ? maximum : value));
    }
}

Related

1. clamp(float value, float min, float max)
2. clamp(float value, float min, float max)
3. clamp(float value, float min, float max)
4. clamp(float value, float min, float max)
5. clamp(float value, float minimum, float maximum)
6. clamp(float x, float a, float b)
7. clamp(float x, float y, float z)
8. clamp180(float r1, float r2)
9. clamp1f(float f)