Package org.hipparchus.analysis.polynomials

Class SmoothStepFactory.QuadraticSmoothStepFunction

java.lang.Object

org.hipparchus.analysis.polynomials.PolynomialFunction

org.hipparchus.analysis.polynomials.SmoothStepFactory.SmoothStepFunction

org.hipparchus.analysis.polynomials.SmoothStepFactory.QuadraticSmoothStepFunction

All Implemented Interfaces:

Serializable, UnivariateDifferentiableFunction, FieldUnivariateFunction, UnivariateFunction

Enclosing class:

SmoothStepFactory

public static class SmoothStepFactory.QuadraticSmoothStepFunction
extends SmoothStepFactory.SmoothStepFunction

Specific smoothstep function that cannot be built using the SmoothStepFactory.getGeneralOrder(int).

Methods inherited from PolynomialFunction should not be used as they will not be true to the actual function.

See Also:

PolynomialFunction, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hipparchus.analysis.polynomials.PolynomialFunction

PolynomialFunction.Parametric

Method Summary

Modifier and Type	Method	Description
double	value(double xNormalized)	Compute the value of the quadratic smoothstep for the given argument normalized between edges.
double	value(double leftEdge, double rightEdge, double x)	Compute the value of the smoothstep function for the given edges and argument.

Methods inherited from class org.hipparchus.analysis.polynomials.SmoothStepFactory.SmoothStepFunction

checkInputEdges, clampInput, normalizeInput

Methods inherited from class org.hipparchus.analysis.polynomials.PolynomialFunction

add, antiDerivative, degree, differentiate, equals, evaluate, getCoefficients, hashCode, integrate, multiply, negate, polynomialDerivative, subtract, toString, value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hipparchus.analysis.FieldUnivariateFunction

toCalculusFieldUnivariateFunction

Method Detail

value

public double value(double leftEdge,
                    double rightEdge,
                    double x)
             throws MathIllegalArgumentException

Compute the value of the smoothstep function for the given edges and argument.

Note that right edge is expected to be greater than left edge. It will throw an exception otherwise.

Overrides:

value in class SmoothStepFactory.SmoothStepFunction

Parameters:

leftEdge - left edge

rightEdge - right edge

x - Argument for which the function value should be computed

Returns:

the value of the polynomial at the given point

Throws:

MathIllegalArgumentException - if right edge is greater than left edge

See Also:

UnivariateFunction.value(double)

value

public double value(double xNormalized)

Compute the value of the quadratic smoothstep for the given argument normalized between edges.

Specified by:

value in interface UnivariateFunction

Overrides:

value in class SmoothStepFactory.SmoothStepFunction

Parameters:

xNormalized - Normalized argument for which the function value should be computed. It is expected to be between [0:1] and will throw an exception otherwise.

Returns:

the value of the polynomial at the given point.

See Also:

UnivariateFunction.value(double)