KernelDensityEstimate.ToPiecewiseDistribution Method

Definition

Namespace: Numerics.NET.Statistics.KernelDensityEstimation
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0

Overload List

ToPiecewiseDistribution(Int32, Nullable<Double>, Nullable<Double>, Double)	Creates a finite-grid piecewise approximation using direct evaluation.
ToPiecewiseDistribution(KernelDensityFftOptions, Int32, Nullable<Double>, Nullable<Double>, Double)	Creates a finite-grid, piecewise approximation to this density.

ToPiecewiseDistribution(Int32, Nullable<Double>, Nullable<Double>, Double)

Creates a finite-grid piecewise approximation using direct evaluation.

public PiecewiseDistribution ToPiecewiseDistribution(
	int pointCount = 512,
	double? lowerBound = null,
	double? upperBound = null,
	double padding = 3
)

Visual Basic

Public Function ToPiecewiseDistribution ( 
	Optional pointCount As Integer = 512,
	Optional lowerBound As Double? = Nothing,
	Optional upperBound As Double? = Nothing,
	Optional padding As Double = 3
) As PiecewiseDistribution

C++/CLI

public:
PiecewiseDistribution^ ToPiecewiseDistribution(
	int pointCount = 512, 
	Nullable<double> lowerBound = nullptr, 
	Nullable<double> upperBound = nullptr, 
	double padding = 3
)

member ToPiecewiseDistribution : 
        ?pointCount : int * 
        ?lowerBound : Nullable<float> * 
        ?upperBound : Nullable<float> * 
        ?padding : float 
(* Defaults:
        let _pointCount = defaultArg pointCount 512
        let _lowerBound = defaultArg lowerBound null
        let _upperBound = defaultArg upperBound null
        let _padding = defaultArg padding 3
*)
-> PiecewiseDistribution

Parameters

pointCount Int32 (Optional): The output point count, including both endpoints. At least 2 are required for evaluation and 3 for a distribution. The default is 512.
lowerBound Nullable<Double> (Optional): The finite lower evaluation bound, or null to use the fitted data and padding.
upperBound Nullable<Double> (Optional): The finite upper evaluation bound, or null to use the fitted data and padding.
padding Double (Optional): Finite nonnegative padding in adjusted fitting-coordinate bandwidths for unspecified bounds. The default is 3.

Return Value

PiecewiseDistribution
A piecewise constant density with a piecewise linear CDF, normalized over the grid interval.

Remarks

Trapezoidal cell masses are normalized before constructing the CDF. Tails outside the grid are omitted. Choose an original-coordinate resolution that resolves the fitted density after any transformation. Default bounds follow EvaluateGrid, including reflected support endpoints and inverse-transformed padded bounds. Corrected fits and non-Gaussian kernels require direct evaluation.

Exceptions

NotSupportedException	FFT controls are supplied for a corrected fit or a non-Gaussian kernel.
ArgumentException	The grid has fewer than three points, its resolved bounds or coordinates are invalid, or the sampled density is not finite, nonnegative and nonzero.
ArgumentOutOfRangeException	The point count, an explicit bound or padding is invalid.

ToPiecewiseDistribution(KernelDensityFftOptions, Int32, Nullable<Double>, Nullable<Double>, Double)

Creates a finite-grid, piecewise approximation to this density.

public PiecewiseDistribution ToPiecewiseDistribution(
	KernelDensityFftOptions? fftOptions,
	int pointCount = 512,
	double? lowerBound = null,
	double? upperBound = null,
	double padding = 3
)

Visual Basic

Public Function ToPiecewiseDistribution ( 
	fftOptions As KernelDensityFftOptions,
	Optional pointCount As Integer = 512,
	Optional lowerBound As Double? = Nothing,
	Optional upperBound As Double? = Nothing,
	Optional padding As Double = 3
) As PiecewiseDistribution

C++/CLI

public:
PiecewiseDistribution^ ToPiecewiseDistribution(
	KernelDensityFftOptions^ fftOptions, 
	int pointCount = 512, 
	Nullable<double> lowerBound = nullptr, 
	Nullable<double> upperBound = nullptr, 
	double padding = 3
)

member ToPiecewiseDistribution : 
        fftOptions : KernelDensityFftOptions * 
        ?pointCount : int * 
        ?lowerBound : Nullable<float> * 
        ?upperBound : Nullable<float> * 
        ?padding : float 
(* Defaults:
        let _pointCount = defaultArg pointCount 512
        let _lowerBound = defaultArg lowerBound null
        let _upperBound = defaultArg upperBound null
        let _padding = defaultArg padding 3
*)
-> PiecewiseDistribution

Parameters

fftOptions KernelDensityFftOptions: Explicit Gaussian FFT controls, or null for direct evaluation.
pointCount Int32 (Optional): The output point count, including both endpoints. At least 2 are required for evaluation and 3 for a distribution. The default is 512.
lowerBound Nullable<Double> (Optional): The finite lower evaluation bound, or null to use the fitted data and padding.
upperBound Nullable<Double> (Optional): The finite upper evaluation bound, or null to use the fitted data and padding.
padding Double (Optional): Finite nonnegative padding in adjusted fitting-coordinate bandwidths for unspecified bounds. The default is 3.

Return Value

PiecewiseDistribution
A piecewise constant density with a piecewise linear CDF, normalized over the grid interval.

Remarks

Exceptions

NotSupportedException	FFT controls are supplied for a corrected fit or a non-Gaussian kernel.
ArgumentException	The grid has fewer than three points, its resolved bounds or coordinates are invalid, or the sampled density is not finite, nonnegative and nonzero.
ArgumentOutOfRangeException	The point count, an explicit bound or padding is invalid.

KernelDensityEstimate.ToPiecewiseDistribution Method

Definition

Overload List

ToPiecewiseDistribution(Int32, Nullable<Double>, Nullable<Double>, Double)

Parameters

Return Value

Remarks

Exceptions

ToPiecewiseDistribution(KernelDensityFftOptions, Int32, Nullable<Double>, Nullable<Double>, Double)

Parameters

Return Value

Remarks

Exceptions

See Also

Reference