Mathematical and statistical functions for the Sigmoid kernel defined by the pdf, $$f(x) = 2/\pi(exp(x) + exp(-x))^{-1}$$ over the support \(x \in R\).

Details

The cdf and quantile functions are omitted as no closed form analytic expressions could be found, decorate with FunctionImputation for numeric results.

Super classes

distr6::Distribution -> distr6::Kernel -> Sigmoid

Public fields

name

Full name of distribution.

short_name

Short name of distribution for printing.

description

Brief description of the distribution.

Methods

Inherited methods


Method new()

Creates a new instance of this R6 class.

Usage

Sigmoid$new(decorators = NULL)

Arguments

decorators

(character())
Decorators to add to the distribution during construction.


Method pdfSquared2Norm()

The squared 2-norm of the pdf is defined by $$\int_a^b (f_X(u))^2 du$$ where X is the Distribution, \(f_X\) is its pdf and \(a, b\) are the distribution support limits.

Usage

Sigmoid$pdfSquared2Norm(x = 0, upper = Inf)

Arguments

x

(numeric(1))
Amount to shift the result.

upper

(numeric(1))
Upper limit of the integral.


Method variance()

The variance of a distribution is defined by the formula $$var_X = E[X^2] - E[X]^2$$ where \(E_X\) is the expectation of distribution X. If the distribution is multivariate the covariance matrix is returned.

Usage

Sigmoid$variance(...)

Arguments

...

Unused.


Method clone()

The objects of this class are cloneable with this method.

Usage

Sigmoid$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.