Java Double Number Clamp clamp(double x, double xMin, double xMax)

Description

If x is between xMin and xMax, then return x; if x is less than xMin, then return xMin; if x is greater than xMax, then return xMax.

License

Apache License

Parameter

Parameter	Description
x	value to clamp
xMin	lower bound
xMax	upper bound

Return

the clamped value

Declaration

public static double clamp(double x, double xMin, double xMax) 

Method Source Code

//package com.java2s;
/*/*  w  ww  . j  ava 2 s. c  om*/
 * Copyright 2016 michaelrohs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

public class Main {
    /**
     * If x is between xMin and xMax, then return x; 
     * if x is less than xMin, then return xMin; 
     * if x is greater than xMax, then return xMax.
     * @param x value to clamp
     * @param xMin lower bound
     * @param xMax upper bound
     * @return the clamped value
     */
    public static double clamp(double x, double xMin, double xMax) {
        return (x < xMin) ? xMin : ((x > xMax) ? xMax : x);
    }

    /**
     * If x is between xMin and xMax, then return x; 
     * if x is less than xMin, then return xMin; 
     * if x is greater than xMax, then return xMax.
     * @param x value to clamp
     * @param xMin lower bound
     * @param xMax upper bound
     * @return the clamped value
     */
    public static int clamp(int x, int xMin, int xMax) {
        return (x < xMin) ? xMin : ((x > xMax) ? xMax : x);
    }
}

Related

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