org.dayflower.pathtracer.util

Class Ranges

java.lang.Object

org.dayflower.pathtracer.util.Ranges

public final class Ranges
extends java.lang.Object

A class that consists exclusively of static methods that performs clamping and other range-specific operations.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static float	requireRange(float value, float minimum, float maximum) Returns value, but only if it is within the range of minimum (inclusive) and maximum (inclusive).
static float	requireRange(float value, float minimum, float maximum, java.lang.String message) Returns value, but only if it is within the range of minimum (inclusive) and maximum (inclusive).

Methods inherited from class java.lang.Object

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

Method Detail

requireRange

public static float requireRange(float value,
                                 float minimum,
                                 float maximum)

Returns value, but only if it is within the range of minimum (inclusive) and maximum (inclusive).

If it is not within said range, an IllegalArgumentException will be thrown.

Calling this method is equivalent to calling Ranges.requireRange(value, minimum, maximum, null).

Parameters:

value - the value to verify

minimum - the minimum value allowed (inclusive)

maximum - the maximum value allowed (inclusive)

Returns:

value, but only if it is within the range of minimum (inclusive) and maximum (inclusive)

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static float requireRange(float value,
                                 float minimum,
                                 float maximum,
                                 java.lang.String message)

Returns value, but only if it is within the range of minimum (inclusive) and maximum (inclusive).

If it is not within said range, an IllegalArgumentException will be thrown.

The message parameter will be the detail message of the thrown IllegalArgumentException. It may be null.

Parameters:

value - the value to verify

minimum - the minimum value allowed (inclusive)

maximum - the maximum value allowed (inclusive)

message - the detail message to the IllegalArgumentException

Returns:

value, but only if it is within the range of minimum (inclusive) and maximum (inclusive)

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum