real_optimizable_pwc_signal

The Boulder Opal Toolkits are currently in beta phase of development. Breaking changes may be introduced.

real_optimizable_pwc_signal(segment_count, duration, maximum, minimum=0.0, initial_values=None, *, name=None)

Create a real optimizable piecewise-constant signal.

Parameters

  • segment_count (int) – The number of piecewise-constant segments in the signal.

  • duration (float) – The duration of the signal.

  • maximum (float) – The upper bound for the signal values.

  • minimum (float, optional) – The lower bound for the signal values. Defaults to 0.

  • initial_values (np.ndarray or list[np.ndarray], optional) – Initial values for the signal. Defaults to None, meaning the optimizer initializes these variables with random values. You can either provide a single array, or a list of them. If a list of arrays are used, they must have the same length.

  • name (str, optional) – The name of the node.

Returns

The optimizable piecewise-constant signal.

Return type

Pwc

See also

utils.complex_optimizable_pwc_signal()

Create a complex optimizable Pwc signal.

optimization_variable()

Create optimization variables, which can be bounded, semi-bounded, or unbounded.

pwc_signal()

Create a piecewise-constant signal.