Function rc_filter_enable_saturation#

Function Documentation#

int rc_filter_enable_saturation(rc_filter_t *f, double min, double max)#

Enables saturation between bounds min and max.

If saturation is enabled for a specified filter, the filter will automatically bound the output between min and max. You may ignore this function if you wish the filter to run unbounded. Max must be greater than or equal to min. If max==min, the output will be fixed at that value. Any double-precision floating point value is allowed, positive or negative.

Parameters:
  • f – Pointer to user’s rc_filter_t struct

  • min[in] The lower bound

  • max[in] The upper bound

Returns:

Returns 0 on success or -1 on failure.