org.hipparchus.analysis.function

Class Sinc

java.lang.Object

org.hipparchus.analysis.function.Sinc

All Implemented Interfaces:

UnivariateDifferentiableFunction, UnivariateFunction

public class Sinc
extends Object
implements UnivariateDifferentiableFunction

Sinc function, defined by

   sinc(x) = 1            if x = 0,
             sin(x) / x   otherwise.
 

Constructor Summary

Constructors

Constructor and Description
Sinc() The sinc function, sin(x) / x.
Sinc(boolean normalized) Instantiates the sinc function.

Method Summary

Modifier and Type	Method and Description
double	value(double x) Compute the value of the function.
<T extends Derivative<T>> T	value(T t) Compute the value for the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sinc

public Sinc()

The sinc function, sin(x) / x.

Sinc

public Sinc(boolean normalized)

Instantiates the sinc function.

Parameters:

normalized - If true, the function is sin(πx) / πx, otherwise sin(x) / x.

Method Detail

value

public double value(double x)

Compute the value of the function.

Specified by:

value in interface UnivariateFunction

Parameters:

x - Point at which the function value should be computed.

Returns:

the value of the function.

value

public <T extends Derivative<T>> T value(T t)
                                  throws MathIllegalArgumentException

Compute the value for the function.

Specified by:

value in interface UnivariateDifferentiableFunction

Type Parameters:

T - the type of the field elements

Parameters:

t - the point for which the function value should be computed

Returns:

the value

Throws:

MathIllegalArgumentException - if x does not satisfy the function's constraints (argument out of bound, or unsupported derivative order for example)