unconstrained (pmrf.unconstrained)

pmrf.unconstrained(value: Array | ndarray | bool | number | bool | int | float | complex, *, fixed: bool = False, scale: float | None = None, name: str | None = None, metadata: Any | None = None) → Param

Create an unconstrained free parameter.

Parameters:
  • value (ArrayLike) – The initial declared value.

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

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

  • scale (float, optional) – The units the value is written in. None, the default, inherits the scale of the field the parameter is passed to, or acts as 1.0.

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

Returns:

An unconstrained parameter.

Return type:

pmrf.Param