\( % Arcus cosine. \def\acos{\cos^{-1}} % Vector projection. \def\projection#1#2{{proj_{#1}\left(#2\right)}} % Vector rejection. \def\rejection#1#2{{rej_{#1}\left(#2\right)}} % Norm. \def\norm#1{{\left\|#1\right\|}} % Cross product. \def\cross#1#2{\mathit{cross}\left(#1,#2\right)} % Dot product. \def\dot#1#2{{#1 \cdot #2}} % Magnitude. \def\mag#1{{\left|#1\right}} \def\group#1{\left(#1\right)}} \def\sbgrp#1{\left\{#1\right\}} \)

Ring1_Intrinsic_clamp

Clamp a value to a range.

Ring1_Result
Ring1_Intrinsic_clamp_suffix
  (
    type* result,
    type x,
    type minimum,
    type maximum
  )

The following table denotes the valid combinations of suffix and type

suffix type
f32 float
f64 double

This function clamps a value to the range 0 (inclusive) and 1 (inclusive):

  • a value smaller than minimum is mapped to minimum.
  • a value greater than maximum is mapped to maximum.
  • negative infinity is mapped to minimum.
  • positive infinity is mapped to maximum.

Parameter Values

result
A pointer to a type variable.
x
The value to clamp.
minimum
The minimum of the range.
maximum
The maximum of the range.

Return Values

Ring1_Result_Success on success, Ring1_Result_Failure on failure.

Post Conditions

If this function fails, then it sets the by-thread status variable.

Below is a list of failure conditions and the status codes indicating them.

Ring1_Status_InvalidArgument
result was NULL.
Ring1_Status_InvalidArgument
x, minimum, and/or maximum is not a number.
Ring1_Status_InvalidArgument
minimum is greater than maximum.

If this function succeeds, then *result was assigned the clamped value.