Sinc (Apache Commons Math 3.6.1 API)

java.lang.Object

org.apache.commons.math3.analysis.function.Sinc

All Implemented Interfaces:: DifferentiableUnivariateFunction, UnivariateDifferentiableFunction, UnivariateFunction

public class Sinc extends Object implements UnivariateDifferentiableFunction, DifferentiableUnivariateFunction

Sinc function, defined by


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

Since:: 3.0

Constructor Summary

Constructors

Constructor

Description

Sinc()

The sinc function, sin(x) / x.

Sinc(boolean normalized)

Instantiates the sinc function.
Method Summary

Modifier and Type

Method

Description

UnivariateFunction

derivative()

Deprecated.
as of 3.1, replaced by value(DerivativeStructure)

double

value(double x)

Compute the value of the function.

DerivativeStructure

value(DerivativeStructure t)

Simple mathematical function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- 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 Details
- 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.
- derivative
  
  @Deprecated public UnivariateFunction derivative()
  
  Deprecated.
  as of 3.1, replaced by value(DerivativeStructure)
  
  Returns the derivative of the function
  
  Specified by:
  
  derivative in interface DifferentiableUnivariateFunction
  
  Returns:
  
  the derivative function
- value
  
  public DerivativeStructure value(DerivativeStructure t) throws DimensionMismatchException
  
  Simple mathematical function.
  UnivariateDifferentiableFunction classes compute both the value and the first derivative of the function.
  
  Specified by:
  
  value in interface UnivariateDifferentiableFunction
  
  Parameters:
  
  t - function input value
  
  Returns:
  
  function result
  
  Throws:
  
  DimensionMismatchException - if t is inconsistent with the function's free parameters or order
  
  Since:
  
  3.1