com.mapbox.services.android.telemetry.utils

Class MathUtils

java.lang.Object

com.mapbox.services.android.telemetry.utils.MathUtils

public class MathUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MathUtils()

Method Summary

Modifier and Type	Method and Description
static double	clamp(double value, double min, double max) Test a value in specified range, returning minimum if it's below, and maximum if it's above
static float	clamp(float value, float min, float max) Test a value in specified range, returning minimum if it's below, and maximum if it's above
static double	convertNativeBearing(double nativeBearing) Convert bearing from core to match Android SDK value.
static double	differenceBetweenAngles(double alpha, double beta) Returns the smallest angle between two angles.
static double	wrap(double value, double min, double max) Constrains value to the given range (including min, excluding max) via modular arithmetic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MathUtils

public MathUtils()

Method Detail

clamp

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

Test a value in specified range, returning minimum if it's below, and maximum if it's above

Parameters:

value - Value to test

min - Minimum value of range

max - Maximum value of range

Returns:

value if it's between min and max, min if it's below, max if it's above

clamp

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

Test a value in specified range, returning minimum if it's below, and maximum if it's above

Parameters:

value - Value to test

min - Minimum value of range

max - Maximum value of range

Returns:

value if it's between min and max, min if it's below, max if it's above

wrap

public static double wrap(double value,
                          double min,
                          double max)

Constrains value to the given range (including min, excluding max) via modular arithmetic.

Same formula as used in Core GL (wrap.hpp) std::fmod((std::fmod((value - min), d) + d), d) + min;

Parameters:

value - Value to wrap

min - Minimum value

max - Maximum value

Returns:

Wrapped value

convertNativeBearing

public static double convertNativeBearing(double nativeBearing)

Convert bearing from core to match Android SDK value.

Parameters:

nativeBearing - bearing value coming from core

Returns:

bearing in degrees starting from 0 rotating clockwise

differenceBetweenAngles

public static double differenceBetweenAngles(double alpha,
                                             double beta)

Returns the smallest angle between two angles.

Parameters:

alpha - First angle in degrees

beta - Second angle in degrees

Returns:

Smallest angle between two angles.