Template Function GridKit::Math::deadband

Function Documentation

template<class ScalarT, typename RealT>
inline ScalarT GridKit::Math::deadband(const ScalarT x, const RealT lower, const RealT upper)

Smooth two-sided deadband function.

Smooth approximation to x - min(max(x, lower), upper), composed from the smooth ramp function.

Template Parameters:

  • ScalarT – - scalar data type

  • RealT – - Real data type (see GridKit::ScalarTraits<ScalarT>::RealT)

Parameters:

  • x – [in] - Input signal

  • lower – [in] - Lower breakpoint

  • upper – [in] - Upper breakpoint

Returns:

Smooth deadbanded value