gov.sandia.cognition.math

Interface UnivariateScalarFunction

All Superinterfaces:

Evaluator<java.lang.Double,java.lang.Double>, ScalarFunction<java.lang.Double>

All Known Subinterfaces:

DifferentiableUnivariateScalarFunction, PolynomialFunction.ClosedForm, SmoothCumulativeDistributionFunction, UnivariateProbabilityDensityFunction

All Known Implementing Classes:

AbstractDifferentiableUnivariateScalarFunction, AbstractUnivariateScalarFunction, AdaptiveRejectionSampling.AbstractEnvelope, AdaptiveRejectionSampling.LineSegment, AdaptiveRejectionSampling.LogEvaluator, AdaptiveRejectionSampling.LowerEnvelope, AdaptiveRejectionSampling.PDFLogEvaluator, AdaptiveRejectionSampling.UpperEnvelope, AtanFunction, BetaDistribution.CDF, BetaDistribution.PDF, CauchyDistribution.CDF, CauchyDistribution.PDF, ChiSquareDistribution.CDF, ChiSquareDistribution.PDF, CosineFunction, DeterministicDistribution.CDF, DirectionalVectorToDifferentiableScalarFunction, DirectionalVectorToScalarFunction, ExponentialDistribution.CDF, ExponentialDistribution.PDF, GammaDistribution.CDF, GammaDistribution.PDF, HardSigmoidFunction, HardTanHFunction, IdentityScalarFunction, InverseGammaDistribution.CDF, InverseGammaDistribution.PDF, LaplaceDistribution.CDF, LaplaceDistribution.PDF, LeakyRectifiedLinearFunction, LinearFunction, LineMinimizerDerivativeBased.InternalFunction, LogisticDistribution.CDF, LogisticDistribution.PDF, LogNormalDistribution.CDF, LogNormalDistribution.PDF, ParetoDistribution.CDF, ParetoDistribution.PDF, PolynomialFunction, PolynomialFunction.Cubic, PolynomialFunction.Linear, PolynomialFunction.Quadratic, RectifiedLinearFunction, ScalarMixtureDensityModel.CDF, ScalarMixtureDensityModel.PDF, SigmoidFunction, SnedecorFDistribution.CDF, SoftPlusFunction, SolverFunction, StandardDistributionNormalizer, StudentTDistribution.CDF, StudentTDistribution.PDF, TanHFunction, ThresholdFunction, UniformDistribution.CDF, UniformDistribution.PDF, UnivariateGaussian.CDF, UnivariateGaussian.CDF.Inverse, UnivariateGaussian.ErrorFunction, UnivariateGaussian.ErrorFunction.Inverse, UnivariateGaussian.PDF, WeibullDistribution.CDF, WeibullDistribution.PDF

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-02-26",
            changesNeeded=false,
            comments="Looks good.")
public interface UnivariateScalarFunction
extends Evaluator<java.lang.Double,java.lang.Double>, ScalarFunction<java.lang.Double>

Simple interface that describes a function that maps the reals to the reals, has a Double to Double and double to double. It is recommended that a UnivariateScalarFunction implement CloneableSerializable, though it is not required.

Since:

2.0

Author:

Kevin R. Dixon

Method Summary

Modifier and Type	Method and Description
double	evaluate(double input) Produces a double output for the given double input
default java.lang.Double	evaluate(java.lang.Double input) Evaluates the function on the given input and returns the output.
default double	evaluateAsDouble(java.lang.Double input) Evaluates the scalar function as a double.

Method Detail

evaluate

double evaluate(double input)

Produces a double output for the given double input

Parameters:

input - Input to the Evaluator

Returns:

output at the given input

evaluate

default java.lang.Double evaluate(java.lang.Double input)

Description copied from interface: Evaluator

Evaluates the function on the given input and returns the output.

Specified by:

evaluate in interface Evaluator<java.lang.Double,java.lang.Double>

Specified by:

evaluate in interface ScalarFunction<java.lang.Double>

Parameters:

input - The input to evaluate.

Returns:

The output produced by evaluating the input.

evaluateAsDouble

default double evaluateAsDouble(java.lang.Double input)

Description copied from interface: ScalarFunction

Evaluates the scalar function as a double.

Specified by:

evaluateAsDouble in interface ScalarFunction<java.lang.Double>

Parameters:

input - The input value.

Returns:

The scalar output calculated from the given input.