parameter.LogNegativeParameter

parameter.LogNegativeParameter(value, upper=0.0)

Parameter constrained to be negative using log transformation.

Maps from unconstrained real space to (-∞, upper) using negative log transformation. Useful for parameters that must remain below a certain threshold.

Parameters

Name	Type	Description	Default
value	Union[float, int, jnp.ndarray]	The initial parameter value (must be < upper).	required
upper	float	Upper bound for the parameter value. Default is 0.0.	`0.0`

Examples

>>> param = LogNegativeParameter(-2.0)  # Always negative
>>> param = LogNegativeParameter(-1.0, upper=5.0)  # Always < 5.0

Methods

Name	Description
tree_flatten	Flatten for JAX pytree registration.
tree_unflatten	Unflatten for JAX pytree registration.

tree_flatten

parameter.LogNegativeParameter.tree_flatten()

Flatten for JAX pytree registration.

tree_unflatten

parameter.LogNegativeParameter.tree_unflatten(aux_data, children)

Unflatten for JAX pytree registration.

# parameter.LogNegativeParameter { #tvboptim.parameter.LogNegativeParameter }

```python
parameter.LogNegativeParameter(value, upper=0.0)
```

Parameter constrained to be negative using log transformation.

Maps from unconstrained real space to (-∞, upper) using negative log transformation.
Useful for parameters that must remain below a certain threshold.

## Parameters {.doc-section .doc-section-parameters}

| Name   | Type                                                                                                         | Description                                          | Default    |
|--------|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|
| value  | [Union](`typing.Union`)\[[float](`float`), [int](`int`), [jnp](`jax.numpy`).[ndarray](`jax.numpy.ndarray`)\] | The initial parameter value (must be < upper).       | _required_ |
| upper  | [float](`float`)                                                                                             | Upper bound for the parameter value. Default is 0.0. | `0.0`      |

## Examples {.doc-section .doc-section-examples}

```python
>>> param = LogNegativeParameter(-2.0)  # Always negative
>>> param = LogNegativeParameter(-1.0, upper=5.0)  # Always < 5.0
```

## Methods

| Name | Description |
| --- | --- |
| [tree_flatten](#tvboptim.parameter.LogNegativeParameter.tree_flatten) | Flatten for JAX pytree registration. |
| [tree_unflatten](#tvboptim.parameter.LogNegativeParameter.tree_unflatten) | Unflatten for JAX pytree registration. |

### tree_flatten { #tvboptim.parameter.LogNegativeParameter.tree_flatten }

```python
parameter.LogNegativeParameter.tree_flatten()
```

Flatten for JAX pytree registration.

### tree_unflatten { #tvboptim.parameter.LogNegativeParameter.tree_unflatten }

```python
parameter.LogNegativeParameter.tree_unflatten(aux_data, children)
```

Unflatten for JAX pytree registration.