Click or drag to resize

UnequalProbabilityRandomSamplingFromInclusionProbabilities Method

Initializes a new instance of the UnequalProbabilityRandomSampling class by specifying the inclusion probabilities assigned to the population units.

Namespace:  Novacta.Analytics
Assembly:  Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0
Syntax
Copy
public static UnequalProbabilityRandomSampling FromInclusionProbabilities(
	DoubleMatrix inclusionProbabilities
)

Parameters

inclusionProbabilities
Type: Novacta.AnalyticsDoubleMatrix
The inclusion probabilities assigned to the population units.

Return Value

Type: UnequalProbabilityRandomSampling
The UnequalProbabilityRandomSampling instance having the specified characteristics.
Exceptions
ExceptionCondition
ArgumentNullExceptioninclusionProbabilities is null.
ArgumentExceptioninclusionProbabilities has Count equal to 1.
-or-
inclusionProbabilities contains entries whose sum differs from an integer more than .001 in absolute value.
ArgumentOutOfRangeExceptioninclusionProbabilities contains at least an entry not belonging to the open interval ]0, 1[.
Remarks

Method FromInclusionProbabilities(DoubleMatrix) creates UnequalProbabilityRandomSampling instances by specifying, for each population unit, its probability of being included in a sample. In this case, the sample size is defined as the sum of such probabilities.

See Also