fmin

Description

Floating-point minimum considering NaN.

Signature

T fmin<T>(
    T x,
    T y)
    where T : __BuiltinFloatingPointType;

vector<T, N> fmin<T, N:int>(
    vector<T, N> x,
    vector<T, N> y)
    where T : __BuiltinFloatingPointType;

Generic Parameters

T: __BuiltinFloatingPointType

N : int

Parameters

x : T

The first value to compare.

y : T

The second value to compare.

x : vector<T, N>

The first value to compare.

y : vector<T, N>

The second value to compare.

Return value

The smaller of the two values, element-wise if vector typed, considering NaN.

Remarks

For metal, if either value is NaN, the other value is returned. If both values are NaN, NaN is returned. For other targets, if x is NaN, y is returned, otherwise the smaller of x and y is returned.

Availability and Requirements

Defined for the following targets:

hlsl

Available in all stages.

glsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

metal

Available in all stages.

spirv

Available in all stages.