GaussianFunction

FunctionWithCachingFunctionReferences
[IoId("00000000-0D98-47EA-8986-33E145EE017E")] public class GaussianFunction : FunctionWithCaching
Represents an immutable gaussian equation.

Constructors

GaussianFunction

#
public GaussianFunction()

GaussianFunction

#
public GaussianFunction(double mean, double deviation, double factor)
Create a new gaussian equation from factors.
Parameters:
mean (double)Mean of distribution.
deviation (double)Standard deviation of distribution.
factor (double)Multiplication factor.

GaussianFunction

#
public GaussianFunction(IReader reader)
Parameters:
reader (IReader)

Properties

Derivative

public sealed override Function Derivative { get; }
Gets a function which is the derivative of this function. The returned function may be either analytic or approximate.
inherited fromFunctionWithCaching
Overrides: Function.Derivative

Deviation

#
public double Deviation { get; }
Standard deviation.

Factor

#
public double Factor { get; }
Vertical scaling.

Integral

public sealed override Function Integral { get; }
Gets a function which is the indefinite integral of this function. The returned function may be analytic or approximate. Note that numeric approximation of indefinite integrals is a slow and not particularly high quality process.
inherited fromFunctionWithCaching
Overrides: Function.Integral

Mean

#
public double Mean { get; }
Mean of equation.

Nomen

public sealed override Nomen Nomen { get; }
Gets a description of this function.
inherited fromFunctionWithCaching
Overrides: Function.Nomen

Notation

public override string Notation { get; }
Gets the notation for this function. Notation is aimed at humans and does not need to return a parseable string.
inherited fromFunctionWithCaching
Overrides: Function.Notation

Ui

#
public override FunctionUi Ui { get; }
Gets a UI object for modifying this function. This property may return null, not all functions must be editable.
Overrides: Function.Ui

Methods

Asymptotes

public virtual Line[] Asymptotes()
Returns an array of *all* the non-vertical asymptotes for this function. This property may return both null and empty arrays, implying no asymptotes. Due to the nature of non-vertical asymptotes, there can only be a finite amount of them.
inherited fromFunction

AutoCoDomain

protected void AutoCoDomain(double x0, double x1, out double y0, out double y1, int samples = 100)
Compute the automatic codomain for a given domain.
inherited fromFunction
Parameters:
x0 (double)Domain start.
x1 (double)Domain end.
y0 (out double)Lowest value in codomain.
y1 (out double)Highest value in codomain.
samples (int = 100)Samples.

DomainEstimate

#
public override void DomainEstimate(out double x0, out double x1, out double y0, out double y1)
Parameters:
x0 (out double)
x1 (out double)
y0 (out double)
y1 (out double)
Overrides: Function.DomainEstimate

EmitDerivative

protected virtual Function EmitDerivative()
Override this method to provide an analytic derivative.
inherited fromFunctionWithCaching

EmitIntegral

protected virtual Function EmitIntegral()
Override this method to provide an analytic indefinite integral.
inherited fromFunctionWithCaching

FromPoints

#
public static GaussianFunction FromPoints(Point2d p0, Point2d p1)
Create a gaussian equation using two points as inputs.
Parameters:
p0 (Point2d)First point specifies the mean (x) and the scaling factor (y).
p1 (Point2d)Second point specifies the standard deviation location.

Holes

public virtual Interval[] Holes(double x0, double x1)
Returns a collection of domains for which this function is not defined. This method may return null or an empty array, implying no undefined domains. This method may also return domains outside of the specified interval.
inherited fromFunction
Parameters:
x0 (double)Lower limit of query domain.
x1 (double)Upper limit of query domain.

Integrate

#
public override double Integrate(double x0, double x1)
Parameters:
x0 (double)
x1 (double)
Overrides: Function.Integrate

Poles

public virtual Pole[] Poles(double x0, double x1)
Returns an array of all the poles (i.e. vertical asymptotes) within a domain. This method may return both null and empty arrays, implying no poles. Furthermore this method may choose to return poles which fall outside of the given domain.
inherited fromFunction
Parameters:
x0 (double)Lower limit of query domain.
x1 (double)Upper limit of query domain.

Store

#
public override void Store(IWriter writer)
Parameters:
writer (IWriter)
Overrides: FunctionWithCaching.Store

Y

#
public override double Y(double x)
Parameters:
x (double)
Overrides: Function.Y

YYYY

public double[] YYYY(double[] x)
Evaluate a large amount of values. Functions may choose to use multiple threads to perform this calculation. This method should not throw, instead every failed evaluation will be represented by a NaN value.
inherited fromFunction
Parameters:
x (double[])Value to evaluate.
Returns: Evaluation results. Array will contain double.NaN entries for failed evaluations.