added in version 1.0.0
belongs to Maven artifact androidx.core:core:1.0.0-beta01
Summary: Methods | Inherited Methods

MathUtils

public class MathUtils
extends Object

java.lang.Object
   ↳ androidx.core.math.MathUtils

A utility class providing functions useful for common mathematical operations.

Summary

Public methods

static double clamp(double value, double min, double max)

This method takes a numerical value and ensures it fits in a given numerical range.

static float clamp(float value, float min, float max)

This method takes a numerical value and ensures it fits in a given numerical range.

static int clamp(int value, int min, int max)

This method takes a numerical value and ensures it fits in a given numerical range.

Inherited methods

Public methods

clamp

added in version 1.0.0
public static double clamp (double value, 
                double min, 
                double max)

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.

Parameters
value double: the value to be clamped.
min double: minimum resulting value.
max double: maximum resulting value.
Returns
double the clamped value.

clamp

added in version 1.0.0
public static float clamp (float value, 
                float min, 
                float max)

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.

Parameters
value float: the value to be clamped.
min float: minimum resulting value.
max float: maximum resulting value.
Returns
float the clamped value.

clamp

added in version 1.0.0
public static int clamp (int value, 
                int min, 
                int max)

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.

Parameters
value int: the value to be clamped.
min int: minimum resulting value.
max int: maximum resulting value.
Returns
int the clamped value.