Java Double Number Clamp clamp(double x, double min, double max)

Description

Returns x if it is within the specified range, or the closest value within the specified range if x is outside the range.

License

Open Source License

Parameter

Parameter	Description
x	The value to threshold.
min	The minimum of the range to threshold to.
max	The maximum of the range to threshold to.

Return

x, if min <= x <= max. min, if x < min. max, if x > max.

Declaration

public static double clamp(double x, double min, double max) 

Method Source Code

//package com.java2s;
/**//from  w w w .j ava 2  s  .c  o  m
 * Java Modular Image Synthesis Toolkit (JMIST)
 * Copyright (C) 2008-2013 Bradley W. Kimmel
 *
 * 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 {
    /**
     * Returns x if it is within the specified range, or the closest
     * value within the specified range if x is outside the range.
     * @param x The value to threshold.
     * @param min The minimum of the range to threshold to.
     * @param max The maximum of the range to threshold to.
     * @return x, if min <= x <= max.  min, if x < min.  max, if x > max.
     */
    public static double clamp(double x, double min, double max) {
        if (x < min) {
            return min;
        } else if (x > max) {
            return max;
        } else {
            return x;
        }
    }

    /**
     * Returns x if it is within the specified range, or the closest
     * value within the specified range if x is outside the range.
     * @param x The value to threshold.
     * @param min The minimum of the range to threshold to.
     * @param max The maximum of the range to threshold to.
     * @return x, if min <= x <= max.  min, if x < min.  max, if x > max.
     */
    public static int clamp(int x, int min, int max) {
        if (x < min) {
            return min;
        } else if (x > max) {
            return max;
        } else {
            return x;
        }
    }

    /**
     * Returns x if it is within the specified range, or the closest
     * value within the specified range if x is outside the range.
     * @param x The value to threshold.
     * @param min The minimum of the range to threshold to.
     * @param max The maximum of the range to threshold to.
     * @return x, if min <= x <= max.  min, if x < min.  max, if x > max.
     */
    public static long clamp(long x, long min, long max) {
        if (x < min) {
            return min;
        } else if (x > max) {
            return max;
        } else {
            return x;
        }
    }
}

Related

1. clamp(double value, final double min, final double max)
2. clamp(double var1, double var2, double var3)
3. clamp(double weight, double lowerBound, double upperBound)
4. clamp(double x, double low, double high)
5. clamp(double x, double min, double max)
6. clamp(double x, double xMin, double xMax)
7. clamp(final double value, final double min, final double max)
8. clamp(final double value, final double min, final double max)
9. clamp01(double d)