opensolaris man page for mlib_signaldtwscalarinit_s16

mlib_SignalDTWScalarInit_S16(3MLIB)			    mediaLib Library Functions			       mlib_SignalDTWScalarInit_S16(3MLIB)

NAME
       mlib_SignalDTWScalarInit_S16 - initialization for scalar data

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

       mlib_status mlib_SignalDTWScalarInit_S16(void *state,
	    const mlib_s16 *dref, mlib_s32 lref, mlib_s32 sref,
	    mlib_s32 delta, mlib_s32 local, mlib_s32 slope);

DESCRIPTION
       The mlib_SignalDTWScalarInit_S16() function initializes the internal state structure for dynamic time warping (DTW) of scalar data.

       The  init  function performs internal state structure allocation and global initialization. Per DTW function call initialization is done in
       DTW function, so the same internal state structure can be reused for multiple DTW function calls.

PARAMETERS
       The function takes the following arguments:

       dref	The reference data array.

       lref	The length of the reference data array.

       sref	The scaling factor of the reference data array, where actual_data = input_data * 2**(-scaling_factor).

       delta	The delta in the endpoint constraints.

       local	The type of the local continuity constraints. MLIB_DTW_ITAKURA for Itakura type constraints.

       slope	The type of the slope weighting. MLIB_DTW_NONE for no slope weighting.

       state	Pointer to the internal state structure.

RETURN VALUES
       The function 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
       mlib_SignalDTWScalarInit_S16(3MLIB),    mlib_SignalDTWScalar_S16(3MLIB),     mlib_SignalDTWScalarPath_S16(3MLIB),     mlib_SignalDTWScalar-
       Free_S16(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007				       mlib_SignalDTWScalarInit_S16(3MLIB)