inputs

Module Contents

Classes

SweepSelector

A class to reprsent a parameter sweep of bools

BoolSweep

A class to reprsent a parameter sweep of bools

StringSweep

A class to reprsent a parameter sweep of strings

EnumSweep

A class to reprsent a parameter sweep of enums

IntSweep

A class to reprsent a parameter sweep of ints

FloatSweep

A class to represent a parameter sweep of floats

Functions

box(name, center, width)

class inputs.SweepSelector(units: str = 'ul', samples: int = None, samples_debug: int = 2, **params)

Bases: param.Selector, bencher.variables.sweep_base.SweepBase

A class to reprsent a parameter sweep of bools

__slots__
values(debug=False) List[Any]

return all the values for a parameter sweep. If debug is true return a reduced list

class inputs.BoolSweep(units: str = 'ul', samples: int = None, samples_debug: int = 2, default=True, **params)

Bases: SweepSelector

A class to reprsent a parameter sweep of bools

class inputs.StringSweep(string_list: List[str], units: str = '', samples: int = None, samples_debug: int = 2, **params)

Bases: SweepSelector

A class to reprsent a parameter sweep of strings

class inputs.EnumSweep(enum_type: enum.Enum | List[enum.Enum], units=' ', samples=None, samples_debug=2, **params)

Bases: SweepSelector

A class to reprsent a parameter sweep of enums

__slots__
class inputs.IntSweep(units='ul', samples=None, samples_debug=2, sample_values=None, **params)

Bases: param.Integer, bencher.variables.sweep_base.SweepBase

A class to reprsent a parameter sweep of ints

__slots__
values(debug=False) List[int]

return all the values for a parameter sweep. If debug is true return the list

_validate_value(val, allow_None)

Implements validation for parameter value

_validate_step(val, step)
class inputs.FloatSweep(units='ul', samples=10, samples_debug=2, sample_values=None, step=None, **params)

Bases: param.Number, bencher.variables.sweep_base.SweepBase

A class to represent a parameter sweep of floats

__slots__
values(debug=False) List[float]

return all the values for a parameter sweep. If debug is true return a reduced list

inputs.box(name, center, width)