Java Integer Clip clipRange(int value, int lowLimit, int highLimit)

Description

This method clips the given value to the range limited by the given low and high limits.

License

Open Source License

Parameter

Parameter	Description
value	specifies the value to be clipped
lowLimit	specifies the low limit of the range.
highLimit	specifies the high limit of the range.

Return

the result of the clipped value.

Declaration

public static int clipRange(int value, int lowLimit, int highLimit) 

Method Source Code

//package com.java2s;
/*/*from  w w  w.j  a v  a  2 s  .  c om*/
 * Copyright (c) 2015 Titan Robotics Club (http://www.titanrobotics.com)
 *
 * 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 {
    /**
     * This method clips the given value to the range limited by the given low and high limits.
     *
     * @param value specifies the value to be clipped
     * @param lowLimit specifies the low limit of the range.
     * @param highLimit specifies the high limit of the range.
     * @return the result of the clipped value.
     */
    public static int clipRange(int value, int lowLimit, int highLimit) {
        return (value < lowLimit) ? lowLimit
                : (value > highLimit) ? highLimit : value;
    }

    /**
     * This method clips the given value to the range limited by the given low and high limits.
     *
     * @param value specifies the value to be clipped
     * @param lowLimit specifies the low limit of the range.
     * @param highLimit specifies the high limit of the range.
     * @return the result of the clipped value.
     */
    public static double clipRange(double value, double lowLimit,
            double highLimit) {
        return (value < lowLimit) ? lowLimit
                : (value > highLimit) ? highLimit : value;
    }

    /**
     * This method clips the given value to the range between -1.0 and 1.0.
     *
     * @param value specifies the value to be clipped
     * @return the result of the clipped value.
     */
    public static double clipRange(double value) {
        return clipRange(value, -1.0, 1.0);
    }
}

Related

1. clipHistogram(final int[] hist, final int[] clippedHist, final int limit)
2. clipInt(int value, int max)
3. clipInt(int value, int min, int max)
4. clipPeerIdFromCurrentThreadName()
5. clipPlus128(int v)
6. clipSigned(int v)