androidx.core.math.MathUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
/*
* Copyright (C) 2016 The Android Open Source Project
*
* 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.
*/
package androidx.core.math;
/**
* A utility class providing functions useful for common mathematical operations.
*/
public class MathUtils {
private MathUtils() {}
/**
* This method takes a numerical value and ensures it fits in a given numerical range. If the
* number is smaller than the minimum required by the range, then the minimum of the range will
* be returned. If the number is higher than the maximum allowed by the range then the maximum
* of the range will be returned.
*
* @param value the value to be clamped.
* @param min minimum resulting value.
* @param max maximum resulting value.
*
* @return the clamped value.
*/
public static float clamp(float value, float min, float max) {
if (value < min) {
return min;
} else if (value > max) {
return max;
}
return value;
}
/**
* This method takes a numerical value and ensures it fits in a given numerical range. If the
* number is smaller than the minimum required by the range, then the minimum of the range will
* be returned. If the number is higher than the maximum allowed by the range then the maximum
* of the range will be returned.
*
* @param value the value to be clamped.
* @param min minimum resulting value.
* @param max maximum resulting value.
*
* @return the clamped value.
*/
public static double clamp(double value, double min, double max) {
if (value < min) {
return min;
} else if (value > max) {
return max;
}
return value;
}
/**
* This method takes a numerical value and ensures it fits in a given numerical range. If the
* number is smaller than the minimum required by the range, then the minimum of the range will
* be returned. If the number is higher than the maximum allowed by the range then the maximum
* of the range will be returned.
*
* @param value the value to be clamped.
* @param min minimum resulting value.
* @param max maximum resulting value.
*
* @return the clamped value.
*/
public static int clamp(int value, int min, int max) {
if (value < min) {
return min;
} else if (value > max) {
return max;
}
return value;
}
}