opensolaris man page for mlib_vectordistance_s16_sat

mlib_VectorDistance_U8_Sat(3MLIB)			    mediaLib Library Functions				 mlib_VectorDistance_U8_Sat(3MLIB)

NAME
       mlib_VectorDistance_U8_Sat,  mlib_VectorDistance_S8_Sat,  mlib_VectorDistance_S16_Sat,  mlib_VectorDistance_S32_Sat - vector Euclidean dis-
       tance

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_VectorDistance_U8_Sat(mlib_d64 *z, const mlib_u8 *x,
	    const mlib_u8 *y, mlib_s32 n);

       mlib_status mlib_VectorDistance_S8_Sat(mlib_d64 *z, const mlib_s8 *x,
	    const mlib_s8 *y, mlib_s32 n);

       mlib_status mlib_VectorDistance_S16_Sat(mlib_d64 *z, const mlib_s16 *x,
	    const mlib_s16 *y, mlib_s32 n);

       mlib_status mlib_VectorDistance_S32_Sat(mlib_d64 *z, const mlib_s32 *x,
	    const mlib_s32 *y, mlib_s32 n);

DESCRIPTION
       Each of these functions computes the Euclidean distances between two vectors.

       The following equation is used:

		  n-1
	 z[0] = { SUM (x[i] - y[i])**2 }**0.5
		  i=0

PARAMETERS
       Each of the functions takes the following arguments:

       z    Pointer to the distance between the two vectors.

       x    Pointer to the first element of the first source vector.

       y    Pointer to the first element of the second source vector.

       n    Number of elements in the vectors.

RETURN VALUES
       Each of the functions returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       attributes(5)

SunOS 5.11							    2 Mar 2007					 mlib_VectorDistance_U8_Sat(3MLIB)