DistHelper: Dist Helper

In SBCK: Statistical Bias Correction Kit

Dist Helper

Description

Class used by CDFt and QM to facilitate fit, do not use

Details

Used to parallel work for margins

Public fields

dist

[ROOPSD distribution] name of class

law

[ROOPSD distribution] class set

kwargs

[list] arguments of dist

Methods

Public methods

• DistHelper$new()

• DistHelper$set_features()

• DistHelper$fit()

• DistHelper$is_frozen()

• DistHelper$is_parametric()

• DistHelper$clone()

---

Method new()

Create a new DistHelper object.

Usage

DistHelper$new(dist, kwargs)

Arguments

dist

[ROOPSD distribution or list] statistical law

kwargs

[list] arguments passed to dist

Returns

A new 'DistHelper' object.

---

Method set_features()

set the number of features

Usage

DistHelper$set_features(n_features)

Arguments

n_features

[integer] numbers of features

Returns

NULL

---

Method fit()

fit the laws

Usage

DistHelper$fit(X, i)

Arguments

X

[matrix] dataset to fit

i

[integer] margins to fit

Returns

NULL

---

Method is_frozen()

Test if margins i is frozen

Usage

DistHelper$is_frozen(i)

Arguments

i

[integer] margins to fit

Returns

[bool]

---

Method is_parametric()

Test if margins i is parametric

Usage

DistHelper$is_parametric(i)

Arguments

i

[integer] margins to fit

Returns

[bool]

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DistHelper$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## 

SBCK documentation built on Sept. 11, 2023, 5:10 p.m.