Package topo :: Package numbergen :: Module basic :: Class BoundedNumber

[frames] | no frames]

Class BoundedNumber

Function object that silently enforces numeric bounds on values returned by a callable object.

Nested Classes

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

source code

Inherited from NumberGenerator: __abs__, __add__, __div__, __floordiv__, __mod__, __mul__, __neg__, __pos__, __pow__, __radd__, __rdiv__, __rfloordiv__, __rmod__, __rmul__, __rpow__, __rsub__, __rtruediv__, __sub__, __truediv__

Inherited from param.parameterized.Parameterized: __getstate__, __init__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_default, set_dynamic_time_fn, set_param, state_pop, state_push, verbose, warning

Inherited from param.parameterized.Parameterized (private): _add_parameter, _instantiate_param, _set_name, _setup_params

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables

generator = param.Callable(None, doc= "Object to call to gener...
Object to call to generate values.

bounds = param.Parameter((None, None), doc= ...
Legal range for the value returned, as a pair.

name = <param.parameterized.String object at 0xb1ff9ec>
String identifier for this object.

Inherited from param.parameterized.Parameterized: print_level

Properties

Inherited from object: __class__

Method Details

call(self)
(Call operator)

Overrides: NumberGenerator.__call__

Class Variable Details

generator

Object to call to generate values.

Value:

param.Callable(None, doc= "Object to call to generate values.")

bounds

Legal range for the value returned, as a pair.

The default bounds are (None,None), meaning there are actually no bounds. One or both bounds can be set by specifying a value. For instance, bounds=(None,10) means there is no lower bound, and an upper bound of 10.

Value:

param.Parameter((None, None), doc= """
        Legal range for the value returned, as a pair.
        
        The default bounds are (None,None), meaning there are actually
        no bounds.  One or both bounds can be set by specifying a
        value.  For instance, bounds=(None,10) means there is no lower
        bound, and an upper bound of 10.""")