com.io7m.jinterp

Class InterpolationF

java.lang.Object

com.io7m.jinterp.InterpolationF

public final class InterpolationF
extends Object

Interpolation functions.

Method Summary

Modifier and Type	Method and Description
static InterpolationFunctionFType	getCosine()
static InterpolationFunctionFType	getExponential()
static InterpolationFunctionFType	getLinear()
static InterpolationFunctionFType	getLogarithmic()
static float	interpolateCosine(float x0, float x1, float a) Interpolate between x0 and x1 based on a such that:
static float	interpolateExponential(float x0, float x1, float factor) Interpolate between x0 and x1 based on factor, using an exponential scale.
static float	interpolateLinear(float x0, float x1, float a) Linearly interpolate between x0 and x1 based on a such that:
static float	interpolateLogarithmic(float x0, float x1, float factor) Interpolate between x0 and x1 based on factor, using a logarithmic scale.

Methods inherited from class java.lang.Object

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

Method Detail

getCosine

public static InterpolationFunctionFType getCosine()

Returns:

An interpolation function based on interpolateCosine(float, float, float).

getExponential

public static InterpolationFunctionFType getExponential()

Returns:

An interpolation function based on interpolateExponential(float, float, float).

getLinear

public static InterpolationFunctionFType getLinear()

Returns:

An interpolation function based on interpolateLinear(float, float, float).

getLogarithmic

public static InterpolationFunctionFType getLogarithmic()

Returns:

An interpolation function based on interpolateLogarithmic(float, float, float).

interpolateCosine

public static float interpolateCosine(float x0,
                                      float x1,
                                      float a)

Interpolate between x0 and x1 based on a such that:

 interpolateCosine (x0, x1, 1.0) == x1
 interpolateCosine (x0, x1, 0.0) == x0
 

Parameters:

x0 - The start value

x1 - The end value

a - The interpolation factor in the range [0.0, 1.0]

Returns:

A value between [x0, x1].

interpolateExponential

public static float interpolateExponential(float x0,
                                           float x1,
                                           float factor)

Interpolate between x0 and x1 based on factor, using an exponential scale. When factor == 0, the function returns x0, when factor == 1, the function returns x1. More formally, the function returns x0 + (factor² * (x1 - x0)) .

Parameters:

factor - The interpolation factor in the range [0.0, 1.0]

x0 - The lower bound.

x1 - The upper bound.

Returns:

A value between [x0, x1].

interpolateLinear

public static float interpolateLinear(float x0,
                                      float x1,
                                      float a)

Linearly interpolate between x0 and x1 based on a such that:

 interpolateLinear (x0, x1, 1.0) == x1
 interpolateLinear (x0, x1, 0.0) == x0
 

Parameters:

x0 - The start value

x1 - The end value

a - The interpolation factor in the range [0.0, 1.0]

Returns:

A value between [x0, x1].

interpolateLogarithmic

public static float interpolateLogarithmic(float x0,
                                           float x1,
                                           float factor)

Interpolate between x0 and x1 based on factor, using a logarithmic scale. When factor == 0, the function returns x0, when factor == 1, the function returns x1. More formally, the function returns x0 + (sqrt(factor) * (x1 - x0)) .

Parameters:

factor - The interpolation factor in the range [0.0, 1.0]

x0 - The lower bound.

x1 - The upper bound.

Returns:

A value between [x0, x1].