Package org.hipparchus.analysis.polynomials

Class SmoothStepFactory

java.lang.Object

org.hipparchus.analysis.polynomials.SmoothStepFactory

public class SmoothStepFactory
extends Object

Smoothstep function factory.

It allows for quick creation of common and generic smoothstep functions as defined here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmoothStepFactory.FieldSmoothStepFunction<T extends CalculusFieldElement<T>>	Smoothstep function as defined here.
static class	SmoothStepFactory.QuadraticSmoothStepFunction	Specific smoothstep function that cannot be built using the getGeneralOrder(int).
static class	SmoothStepFactory.SmoothStepFunction	Smoothstep function as defined here.

Method Summary

Modifier and Type	Method	Description
static void	checkBetweenZeroAndOneIncluded(double input)	Check that input is between [0:1].
static SmoothStepFactory.SmoothStepFunction	getClamp()	Get the clamping smoothstep function.
static <T extends CalculusFieldElement<T>> SmoothStepFactory.FieldSmoothStepFunction<T>	getClamp(Field<T> field)	Get the clamping smoothstep function.
static SmoothStepFactory.SmoothStepFunction	getCubic()	Get the cubic smoothstep function.
static <T extends CalculusFieldElement<T>> SmoothStepFactory.FieldSmoothStepFunction<T>	getCubic(Field<T> field)	Get the cubic smoothstep function.
static <T extends CalculusFieldElement<T>> SmoothStepFactory.FieldSmoothStepFunction<T>	getFieldGeneralOrder(Field<T> field, int N)	Create a smoothstep function of order 2N + 1.
static SmoothStepFactory.SmoothStepFunction	getGeneralOrder(int N)	Create a smoothstep function of order 2N + 1.
static SmoothStepFactory.SmoothStepFunction	getQuadratic()	Get the quadratic smoothstep function.
static <T extends CalculusFieldElement<T>> SmoothStepFactory.FieldSmoothStepFunction<T>	getQuadratic(Field<T> field)	Get the quadratic smoothstep function.
static SmoothStepFactory.SmoothStepFunction	getQuintic()	Get the quintic smoothstep function.
static <T extends CalculusFieldElement<T>> SmoothStepFactory.FieldSmoothStepFunction<T>	getQuintic(Field<T> field)	Get the quintic smoothstep function.

Methods inherited from class java.lang.Object

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

Method Details

getClamp

public static SmoothStepFactory.SmoothStepFunction getClamp()

Get the clamping smoothstep function.

Returns:

clamping smoothstep function

getQuadratic

public static SmoothStepFactory.SmoothStepFunction getQuadratic()

Get the quadratic smoothstep function.

Returns:

clamping smoothstep function

getCubic

public static SmoothStepFactory.SmoothStepFunction getCubic()

Get the cubic smoothstep function.

Returns:

cubic smoothstep function

getQuintic

public static SmoothStepFactory.SmoothStepFunction getQuintic()

Get the quintic smoothstep function.

Returns:

quintic smoothstep function

getClamp

public static <T extends CalculusFieldElement<T>>
SmoothStepFactory.FieldSmoothStepFunction<T> getClamp(Field<T> field)

Get the clamping smoothstep function.

Type Parameters:

T - type of the field element

Parameters:

field - field of the element

Returns:

clamping smoothstep function

getQuadratic

public static <T extends CalculusFieldElement<T>>
SmoothStepFactory.FieldSmoothStepFunction<T> getQuadratic(Field<T> field)

Get the quadratic smoothstep function.

Type Parameters:

T - type of the field element

Parameters:

field - field of the element

Returns:

clamping smoothstep function

getCubic

public static <T extends CalculusFieldElement<T>>
SmoothStepFactory.FieldSmoothStepFunction<T> getCubic(Field<T> field)

Get the cubic smoothstep function.

Type Parameters:

T - type of the field element

Parameters:

field - field of the element

Returns:

cubic smoothstep function

getQuintic

public static <T extends CalculusFieldElement<T>>
SmoothStepFactory.FieldSmoothStepFunction<T> getQuintic(Field<T> field)

Get the quintic smoothstep function.

Type Parameters:

T - type of the field element

Parameters:

field - field of the element

Returns:

quintic smoothstep function

getGeneralOrder

public static SmoothStepFactory.SmoothStepFunction getGeneralOrder(int N)

Create a smoothstep function of order 2N + 1.

It uses the general smoothstep equation presented here : $S_{N}(x) = \sum_{n=0}^{N} \begin{pmatrix} -N-1 \\ n \end{pmatrix} \begin{pmatrix} 2N+1 \\ N-n \end{pmatrix} x^{N+n+1}$

Parameters:

N - determines the order of the output smoothstep function (=2N + 1)

Returns:

smoothstep function of order 2N + 1

getFieldGeneralOrder

public static <T extends CalculusFieldElement<T>>
SmoothStepFactory.FieldSmoothStepFunction<T> getFieldGeneralOrder(Field<T> field,
 int N)

Create a smoothstep function of order 2N + 1.

It uses the general smoothstep equation presented here : $S_{N}(x) = \sum_{n=0}^{N} \begin{pmatrix} -N-1 \\ n \end{pmatrix} \begin{pmatrix} 2N+1 \\ N-n \end{pmatrix} x^{N+n+1}$

Type Parameters:

T - type of the field element

Parameters:

field - field of the element

N - determines the order of the output smoothstep function (=2N + 1)

Returns:

smoothstep function of order 2N + 1

checkBetweenZeroAndOneIncluded

public static void checkBetweenZeroAndOneIncluded(double input)
                                           throws MathIllegalArgumentException

Check that input is between [0:1].

Parameters:

input - input to be checked

Throws:

MathIllegalArgumentException - if input is not between [0:1]