shamo.core.problems.parametric.components.value.CompParamValue

class shamo.core.problems.parametric.components.value.CompParamValue(**kwargs)[source]

Bases: shamo.core.problems.single.components.abc.CompABC

Store information about a random value.

Other Parameters
valshamo.DistABC

The random value.

Methods

check

Check if the value is properly set.

clear

copy

fromkeys

Create a new dictionary with keys from iterable and values set to value.

get

Return the value for key if key is in the dictionary, else default.

items

keys

pop

If key is not found, d is returned if given, otherwise KeyError is raised

popitem

Remove and return a (key, value) pair as a 2-tuple.

set

Set the random value.

setdefault

Insert key with a value of default if key is not in the dictionary.

to_param

Return the fixed and varying parameters separately.

to_pro_param

Return None.

to_py_param

Return None.

update

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values

Attributes

val

Return the random value.

check(name, **kwargs)[source]

Check if the value is properly set.

Parameters
namestr

The name of the value.

Raises
TypeError

If the value is not a distribution.

clear() → None. Remove all items from D.
copy() → a shallow copy of D
fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D’s items
keys() → a set-like object providing a view on D’s keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

set(val)[source]

Set the random value.

Parameters
valshamo.DistABC

The random value.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

to_param(name='', **kwargs)[source]

Return the fixed and varying parameters separately.

Parameters
namestr

The name of the property.

Returns
list [list [str, list [float, str | None]]]

The fixed parameters.

list [list [str, list [shamo.DistABC, str | None]]]

The varying parameters.

to_pro_param(**kwargs)[source]

Return None.

to_py_param(**kwargs)[source]

Return None.

update([E, ]**F) → None. Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

property val

Return the random value.

Returns
shamo.DistABC

The random value.

values() → an object providing a view on D’s values