impeller::saturated Namespace Reference

Functions
	ONLY_ON_SIGNED_INT (SI) Add(SI location
	ONLY_ON_FLOAT (FP) Add(FP location
	ONLY_ON_SIGNED_INT_RET (SI, Scalar) AverageScalar(SI a
	ONLY_ON_SAME_TYPES (T, U) Cast(T v)
	ONLY_ON_FLOAT_TO_SIGNED_INT (FP, SI) Cast(FP v)
	ONLY_ON_DIFFERING_FLOAT (FP1, FP2) Cast(FP1 v)

Variables
template<typename T >
constexpr bool	is_signed_integral_v
SI	distance
SI	lower
SI	b

Function Documentation

ONLY_ON_DIFFERING_FLOAT()

impeller::saturated::ONLY_ON_DIFFERING_FLOAT	(	FP1	,
		FP2
	)

Definition at line 122 of file saturated_math.h.

                                              {
  if (std::isfinite(v)) {
    // Avoid truncation to inf/-inf.
    return std::clamp(static_cast<FP2>(v),  //
                      std::numeric_limits<FP2>::lowest(),
                      std::numeric_limits<FP2>::max());
  } else {
    return static_cast<FP2>(v);
  }
}

ONLY_ON_FLOAT()

impeller::saturated::ONLY_ON_FLOAT

(

FP

)

References distance, and location.

ONLY_ON_FLOAT_TO_SIGNED_INT()

impeller::saturated::ONLY_ON_FLOAT_TO_SIGNED_INT	(	FP	,
		SI
	)

Definition at line 113 of file saturated_math.h.

                                               {
  if (v <= static_cast<FP>(std::numeric_limits<SI>::min())) {
    return std::numeric_limits<SI>::min();
  } else if (v >= static_cast<FP>(std::numeric_limits<SI>::max())) {
    return std::numeric_limits<SI>::max();
  }
  return static_cast<SI>(v);
}

ONLY_ON_SAME_TYPES()

impeller::saturated::ONLY_ON_SAME_TYPES	(	T	,
		U
	)

Definition at line 109 of file saturated_math.h.

                                   {
  return v;
}

ONLY_ON_SIGNED_INT()

impeller::saturated::ONLY_ON_SIGNED_INT

(

SI

)

ONLY_ON_SIGNED_INT_RET()

impeller::saturated::ONLY_ON_SIGNED_INT_RET	(	SI	,
		Scalar
	)

Variable Documentation

b

FP impeller::saturated::b

Initial value:

{
  
  
  return static_cast<Scalar>(std::scalbn(a, -1) + std::scalbn(b, -1))

Definition at line 87 of file saturated_math.h.

distance

FP impeller::saturated::distance

Initial value:

{
  if (location >= 0) {
    if (distance > std::numeric_limits<SI>::max() - location) {
      return std::numeric_limits<SI>::max();
    }
  } else if (distance < std::numeric_limits<SI>::min() - location) {
    return std::numeric_limits<SI>::min();
  }
  return location + distance

Definition at line 57 of file saturated_math.h.

                                                     {
  if (location >= 0) {
    if (distance > std::numeric_limits<SI>::max() - location) {
      return std::numeric_limits<SI>::max();
    }
  } else if (distance < std::numeric_limits<SI>::min() - location) {
    return std::numeric_limits<SI>::min();
  }

Referenced by ONLY_ON_FLOAT().

is_signed_integral_v

template<typename T >

constexpr bool impeller::saturated::is_signed_integral_v

inlineconstexpr

Initial value:

=
    std::is_integral_v<T> && std::is_signed_v<T>

Definition at line 21 of file saturated_math.h.

lower

FP impeller::saturated::lower

Initial value:

{
  if (upper >= 0) {
    if (lower < 0 && upper > std::numeric_limits<SI>::max() + lower) {
      return std::numeric_limits<SI>::max();
    }
  } else if (lower > 0 && upper < std::numeric_limits<SI>::min() + lower) {
    return std::numeric_limits<SI>::min();
  }
  return upper - lower

Definition at line 72 of file saturated_math.h.

                                               {
  if (upper >= 0) {
    if (lower < 0 && upper > std::numeric_limits<SI>::max() + lower) {
      return std::numeric_limits<SI>::max();
    }
  } else if (lower > 0 && upper < std::numeric_limits<SI>::min() + lower) {
    return std::numeric_limits<SI>::min();
  }