probly.representation.credal_set.array.ArrayDistanceBasedCredalSet

class probly.representation.credal_set.array.ArrayDistanceBasedCredalSet(nominal: ArrayCategoricalDistribution, radius: ndarray)

Bases: ArrayAxisProtected[ArrayCategoricalDistribution], ArrayCategoricalCredalSet, DistanceBasedCredalSet

Distance-based credal set around a nominal categorical distribution.

property T: Self

The transposed version of the underlying array.

astype(dtype: DTypeLike, order: Order = 'K', casting: Literal['no', 'equiv', 'safe', 'same_kind', 'unsafe'] = 'unsafe', subok: bool = True, copy: bool = True) → Self

Copy of the array, cast to a specified type.

property barycenter: ArrayCategoricalDistribution

Return the nominal distribution as the barycenter of the credal set.

copy(order: Order = 'C') → Self

Return a copy of the array.

property device: str

Device of the array.

property dtype: dtype

Data type of the array.

property flags: ArrayFlagsLike

The flags of the array.

classmethod from_array_sample(sample: ArraySample[ArrayCategoricalDistribution]) → Self

Create a credal set from categorical distribution samples.

classmethod from_sample(sample: Sample[ArrayCategoricalDistribution]) → Self

Create a credal set from a sample of categorical distributions.

lower() → ndarray

Compute the lower envelope of the credal set.

For L1/TV distance, the tightest element-wise lower bound is max(0, nominal - radius).

property mT: Self

The transposed version of the underlying array.

property ndim: int

Number of dimensions.

nominal: ArrayCategoricalDistribution

property num_classes: int

Return the number of classes in the credal set.

permitted_functions = {}

permitted_ufuncs = {}

classmethod primary_protected_name() → str

Return the first protected field (dict order).

protected_axes: ClassVar[dict[str, int]] = {'nominal': 0, 'radius': 0}

property protected_shape: tuple[int, ...]

Protected trailing shape of the primary field.

protected_value() → ArrayProtectedValue

Return the primary protected value.

protected_values(func: Callable | None = None, method: str | None = None) → dict[str, ArrayProtectedValue] | None

Return all protected field values.

The values are preserved as-is and are not coerced to np.ndarray. Optionally takes the function that triggered the call for context. This can be used to conditionally modify the returned values or prevent them from being accessed.

radius: np.ndarray

reshape(*shape: int | tuple[int, ...], order: str = 'C', copy: bool | None = None) → Self

Return a copy with reshaped protected values.

property shape: tuple[int, ...]

Shape of the array.

property size: int

Number of elements in the array.

to_device(device: Any, /, *, stream: Any = None) → Self

Move the array to a device.

transpose(*axes: int | None) → Self

Return a transposed version of the ArraySample.

This method implicitly also provides full axis tracking support for - np.moveaxis - np.rollaxis Those functions call out to transpose methods for custom array types.

Parameters:

axes – The axes to transpose.

Returns:

A transposed version of the ArraySample.

type = 'categorical'

upper() → ndarray

Compute the upper envelope of the credal set.

For L1/TV distance, the tightest element-wise upper bound is min(1, nominal + radius).

with_protected_value(value: ArrayProtectedValue) → Self

Return a copy with a replaced primary protected value.

with_protected_values(values: dict[str, ArrayProtectedValue]) → Self

Return a copy with updated protected field values.

Examples using probly.representation.credal_set.array.ArrayDistanceBasedCredalSet

Plotting binary credal sets on an interval

Plotting binary credal sets on an interval

Plotting credal sets on the simplex

Plotting credal sets on the simplex

Plotting credal sets on a spider (radar) chart

Plotting credal sets on a spider (radar) chart

Distance-based credal set

Distance-based credal set