Rate This Document
Findability
Accuracy
Completeness
Readability

v?minmag

Return the one with a smaller magnitude in x and y, where x and y are vector arrays.

Interface Definition

C interface:

void vsminmag(const int len, const float* src1, const float* src2, float* dst);

void vdminmag(const int len, const double* src1, const double* src2, double* dst);

Parameters

Parameter

Type

Description

Input/Output

len

Integer

Number of elements in the input vector.

If len ≤ 0, an invalid parameter error is reported and the function returns.

Input

src1

  • Single-precision floating-point type for vsminmag
  • Double-precision floating-point type for vdminmag

Input vector src1 with length len.

If the pointer is null, a null pointer error is reported and the function returns.

Input

src2

  • Single-precision floating-point type for vsminmag
  • Double-precision floating-point type for vdminmag

Input vector src2 with length len.

If the pointer is null, a null pointer error is reported and the function returns.

Input

dst

  • Single-precision floating-point type for vsminmag
  • Double-precision floating-point type for vdminmag

Output vector dst with length len.

If the pointer is null, a null pointer error is reported and the function returns.

Output

Return Value

  • The return value conforms to the following rules:

    If |x| < |y|, x is returned.

    If |x| > |y|, y is returned.

    If |x| = |y|, fmin (x, y) is returned.

  • For special values, see the following table.

    Input Value 1 (src1)

    Input Value 2 (src2)

    Output Value (dst)

    != nan

    nan

    x

    nan

    != nan

    y

    nan

    nan

    nan

Dependencies

C: "kvml.h"

Examples

C interface:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    int i, len = 8; 
    float src1[8] = {-1.5f, -0.0f, 0.0f, 1.0f, 1.5f, -INFINITY, INFINITY, NAN};
    float src2[8] = {-1.1f, 0.0f, +0.0f, -1.0f, -1.5f, +INFINITY, -INFINITY, -NAN}; 
    float* dst = (float*)malloc(sizeof(float) * len); 
    if (dst == NULL) { 
        printf("Malloc Failed!\n"); 
        return 0;
    }
    vsminmag(len, src1, src2, dst);

    /** 
     *  Output dst: 
     *     -1.100000 -0.000000 0.000000 -1.000000 -1.500000 -inf -inf nan
     */