geometry.Parameter
geometry.Parameter(
value,
free=False,
name=None,
bounds=None,
_constraints=list(),
)Base class for optimizable parameters.
Parameters are FIXED by default. Mark as free=True to make them optimizable.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| value | Union[float, Array] | Initial/current value | required |
| free | bool | Whether this parameter is free (optimizable). Default: False | False |
| name | Optional[str] | Optional name for debugging | None |
| bounds | Optional[tuple] | Optional (min, max) bounds for optimization | None |
| _constraints | list[Constraint] | Internal list of constraints that reference this parameter | list() |
Attributes
| Name | Description |
|---|---|
| fixed | Whether this parameter is fixed (non-optimizable). |
Methods
| Name | Description |
|---|---|
| add_constraint | Register a constraint that references this parameter. |
| get_constraints | Get all constraints that reference this parameter. |
| tree_flatten | Flatten for JAX pytree. |
| tree_unflatten | Unflatten from JAX pytree. |
add_constraint
geometry.Parameter.add_constraint(constraint)Register a constraint that references this parameter.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| constraint | Constraint | Constraint to register | required |
get_constraints
geometry.Parameter.get_constraints()Get all constraints that reference this parameter.
Returns
| Name | Type | Description |
|---|---|---|
| list[Constraint] | List of Constraint objects |
tree_flatten
geometry.Parameter.tree_flatten()Flatten for JAX pytree.
tree_unflatten
geometry.Parameter.tree_unflatten(aux_data, children)Unflatten from JAX pytree.