distr6 (version 1.5.6)

DistributionWrapper: Abstract DistributionWrapper Class

Description

Abstract class that cannot be constructed directly.

Value

Returns error. Abstract classes cannot be constructed directly.

Super class

distr6::Distribution -> DistributionWrapper

Methods

Public methods

• DistributionWrapper$new()

• DistributionWrapper$wrappedModels()

• DistributionWrapper$setParameterValue()

• DistributionWrapper$clone()

• distr6::Distribution$cdf()

• distr6::Distribution$correlation()

• distr6::Distribution$getParameterValue()

• distr6::Distribution$iqr()

• distr6::Distribution$liesInSupport()

• distr6::Distribution$liesInType()

• distr6::Distribution$median()

• distr6::Distribution$parameters()

• distr6::Distribution$pdf()

• distr6::Distribution$prec()

• distr6::Distribution$print()

• distr6::Distribution$quantile()

• distr6::Distribution$rand()

• distr6::Distribution$stdev()

• distr6::Distribution$strprint()

• distr6::Distribution$summary()

• distr6::Distribution$workingSupport()

Method new()

Creates a new instance of this R6 class.

Usage

DistributionWrapper$new(
  distlist = NULL,
  name,
  short_name,
  description,
  support,
  type,
  valueSupport,
  variateForm,
  parameters = NULL,
  outerID = NULL
)

Arguments

distlist

(list()) List of Distributions.

name

(character(1)) Wrapped distribution name.

short_name

(character(1)) Wrapped distribution ID.

description

(character()) Wrapped distribution description.

support

([set6::Set]) Wrapped distribution support.

type

([set6::Set]) Wrapped distribution type.

valueSupport

(character(1)) Wrapped distribution value support.

variateForm

(character(1)) Wrapped distribution variate form.

parameters

([ParameterSetCollection]) Optional parameters to add to the internal collection, ignored if distlist is given.

outerID

([ParameterSet]) Parameters added by the wrapper.

Method wrappedModels()

Returns model(s) wrapped by this wrapper.

Usage

DistributionWrapper$wrappedModels(model = NULL)

Arguments

model

(character(1)) id of wrapped Distributions to return. If NULL (default), a list of all wrapped Distributions is returned; if only one Distribution is matched then this is returned, otherwise a list of Distributions.

Method setParameterValue()

Sets the value(s) of the given parameter(s).

Usage

DistributionWrapper$setParameterValue(
  ...,
  lst = NULL,
  error = "warn",
  resolveConflicts = FALSE
)

Arguments

...

ANY Named arguments of parameters to set values for. See examples.

lst

(list(1)) Alternative argument for passing parameters. List names should be parameter names and list values are the new values to set.

error

(character(1)) If "warn" then returns a warning on error, otherwise breaks if "stop".

resolveConflicts

(logical(1)) If FALSE (default) throws error if conflicting parameterisations are provided, otherwise automatically resolves them by removing all conflicting parameters.

Method clone()

The objects of this class are cloneable with this method.

Usage

DistributionWrapper$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Wrappers in distr6 use the composite pattern (Gamma et al. 1994), so that a wrapped distribution has the same methods and fields as an unwrapped one. After wrapping, the parameters of a distribution are prefixed with the distribution name to ensure uniqueness of parameter IDs.

Use listWrappers function to see constructable wrappers.

References

Gamma, Erich, Richard Helm, Ralph Johnson, and John Vlissides. 1994. <U+201C>Design Patterns: Elements of Reusable Object-Oriented Software.<U+201D> Addison-Wesley.

See Also

Other wrappers: Convolution, HuberizedDistribution, MixtureDistribution, ProductDistribution, TruncatedDistribution, VectorDistribution