Differences

This shows you the differences between two versions of the page.

Link to this comparison view

ref:range_penalty [2020/01/03 14:19]
ref:range_penalty [2020/06/19 15:47] (current)
Line 1: Line 1:
 +====== RangePenalty ======
 +Helper type to compute penalty if a value is outside a specific [[range|Range]]. ​
 +
 +The penalty corresponds to ''​abs_penalty * | //E// | + squared_penalty * //​E//​^2'',​ where //E// is the amount a value is out of the specified [[range|Range]]. ​
 +
 +**Inherits from** [[range|scone::​Range<​ T >]].
 +
 +==== Public Attributes ====
 +^ Parameter ^ Type ^ Description ^
 +^ abs_penalty | Real | Absolute penalty factor when value is out of range; default = 0. |
 +^ squared_penalty | Real | Squared penalty factor when value out of range; default = 0. |
 +^ mode_ | penalty_mode | Use the peek range violation instead of average range violation; default = 0. |
 +^ min | T | Minimum value or lower bound of the range; default = -inf. |
 +^ max | T | Maximum value or upper bound of the range; default = inf. |
 +
 +<​sub>​Converted from doxygen using [[https://​github.com/​tgeijten/​dokugen|dokugen]]</​sub>​