pyhelios.ParameterOptimization.ConstrainedResult Class Reference

One evaluation of a constrained simulation. More...

Detailed Description

One evaluation of a constrained simulation.

Returned by the callable passed to :meth:ParameterOptimization.runConstrained, which computes the objective, the constraints, and every gradient in a single pass. The optimizer caches this per parameter point, so a simulation that runs a full Helios scene is evaluated once rather than once per constraint.

Parameters

objective	Scalar cost to minimize
objective_gradient	Partial derivative of the objective for every parameter
constraints	Constraint values; constraint i is satisfied when its value is <= 0
constraint_gradients	One gradient mapping per constraint, in the same order

Definition at line 476 of file ParameterOptimization.py.

Static Public Attributes
Dict	objective_gradient [str, float]
Sequence	constraints [float]
Sequence	constraint_gradients [Dict[str, float]]

Member Data Documentation

constraint_gradients

Sequence pyhelios.ParameterOptimization.ConstrainedResult.constraint_gradients [Dict[str, float]]

static

Definition at line 481 of file ParameterOptimization.py.

constraints

Sequence pyhelios.ParameterOptimization.ConstrainedResult.constraints [float]

static

Definition at line 480 of file ParameterOptimization.py.

objective_gradient

Dict pyhelios.ParameterOptimization.ConstrainedResult.objective_gradient [str, float]

static

Definition at line 479 of file ParameterOptimization.py.

---

The documentation for this class was generated from the following file:

• pyhelios/ParameterOptimization.py