Bounded

pmrf.parameters.Bounded(lower: Any, upper: Any, *, value: Array | ndarray | bool | number | bool | int | float | complex | None = None, fixed: bool = False, name: str | None = None, scale: float = 1.0, metadata: Any | None = None) Param

Create a free parameter constrained within a specific interval.

Used as the main factory to define parameters for bounded optimization.

Parameters:
  • lower (Any) – The lower bound of the interval.

  • upper (Any) – The upper bound of the interval.

  • value (Optional[ArrayLike], optional) – The initial unscaled value. If None, the midpoint of the bounds is used.

  • fixed (bool, optional) – Initializes the parameter as fixed. Defaults to False.

  • name (str, optional) – A name for the parameter, by default None.

  • scale (float, optional) – The scaling factor to apply, by default 1.0.

  • metadata (Any, optional) – Arbitrary metadata for the parameter, by default None.

Returns:

The bounded parameter.

Return type:

pmrf.Param