gov.sandia.cognition.math

Interface ScalarFunction<InputType>

Type Parameters:

InputType - The type of the input to the scalar function.

All Superinterfaces:

Evaluator<InputType,java.lang.Double>

All Known Subinterfaces:

DifferentiableUnivariateScalarFunction, PolynomialFunction.ClosedForm, Regressor<InputType>, SmoothCumulativeDistributionFunction, UnivariateProbabilityDensityFunction, UnivariateScalarFunction

All Known Implementing Classes:

AbstractDifferentiableUnivariateScalarFunction, AbstractRegressor, AbstractScalarFunction, AbstractUnivariateScalarFunction, AdaptiveRejectionSampling.AbstractEnvelope, AdaptiveRejectionSampling.LineSegment, AdaptiveRejectionSampling.LogEvaluator, AdaptiveRejectionSampling.LowerEnvelope, AdaptiveRejectionSampling.PDFLogEvaluator, AdaptiveRejectionSampling.UpperEnvelope, AdditiveEnsemble, AtanFunction, AveragingEnsemble, BetaDistribution.CDF, BetaDistribution.PDF, CauchyDistribution.CDF, CauchyDistribution.PDF, ChiSquareDistribution.CDF, ChiSquareDistribution.PDF, CosineFunction, DeterministicDistribution.CDF, DirectionalVectorToDifferentiableScalarFunction, DirectionalVectorToScalarFunction, ExponentialDistribution.CDF, ExponentialDistribution.PDF, FactorizationMachine, GammaDistribution.CDF, GammaDistribution.PDF, HardSigmoidFunction, HardTanHFunction, IdentityScalarFunction, InverseGammaDistribution.CDF, InverseGammaDistribution.PDF, KernelScalarFunction, LaplaceDistribution.CDF, LaplaceDistribution.PDF, LeakyRectifiedLinearFunction, LinearCombinationScalarFunction, LinearDiscriminant, LinearDiscriminantWithBias, LinearFunction, LinearVectorScalarFunction, LineMinimizerDerivativeBased.InternalFunction, LocallyWeightedKernelScalarFunction, LogisticDistribution.CDF, LogisticDistribution.PDF, LogNormalDistribution.CDF, LogNormalDistribution.PDF, ParetoDistribution.CDF, ParetoDistribution.PDF, PolynomialFunction, PolynomialFunction.Cubic, PolynomialFunction.Linear, PolynomialFunction.Quadratic, RectifiedLinearFunction, RegressionTree, 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, VectorEntryFunction, VectorFunctionLinearDiscriminant, VectorFunctionToScalarFunction, WeibullDistribution.CDF, WeibullDistribution.PDF, WeightedAdditiveEnsemble, WeightedAveragingEnsemble

public interface ScalarFunction<InputType>
extends Evaluator<InputType,java.lang.Double>

Interface for a function that maps some input onto a double.

Since:

3.3.3

Author:

Justin Basilico

Method Summary

Modifier and Type	Method and Description
default java.lang.Double	evaluate(InputType input) Returns the result of calling evaluateAsDouble.
double	evaluateAsDouble(InputType input) Evaluates the scalar function as a double.

Method Detail

evaluateAsDouble

double evaluateAsDouble(InputType input)

Evaluates the scalar function as a double.

Parameters:

input - The input value.

Returns:

The scalar output calculated from the given input.

evaluate

default java.lang.Double evaluate(InputType input)

Returns the result of calling evaluateAsDouble.

Specified by:

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

Parameters:

input - The input value.

Returns:

The result evaluated as a double.