QSAS_2_4/QSAS_dist/src/Ext/CorrelationCoefficient/CorCoef.h File Reference

Classes
struct	CorCoefpacket_s
Defines
#define	CORCOEF
Typedefs
typedef struct CorCoefpacket_s	CorCoefpacket
typedef enum CorCoefReturnStatus_e	CorCoefReturnStatus
typedef enum StatsSuccessorFailure_e	StatsSuccessorFailure
Enumerations
enum	CorCoefReturnStatus_e {   CORCOEF_OK, CORCOEF_TOO_MANY_LAGS_ERROR, CORCOEF_CROSS_COR_ERROR, CORCOEF_STATS_ERROR,   CORCOEF_UNDEFINED }
enum	StatsSuccessorFailure_e { STATSSUCCESS = 0, STATSFAILURE }
Functions
CorCoefReturnStatus	Xcor (CorCoefpacket *ccpacketp)
CorCoefReturnStatus	CorCoef (CorCoefpacket *ccpacketp)
StatsSuccessorFailure	stats (float *x, int n, float *xbarp, float *sigmap)
Variables
static const char *	CorCoefErrorMessage [5]

---

Define Documentation

#define CORCOEF

---

Typedef Documentation

typedef struct CorCoefpacket_s CorCoefpacket

typedef enum CorCoefReturnStatus_e CorCoefReturnStatus

typedef enum StatsSuccessorFailure_e StatsSuccessorFailure

---

Enumeration Type Documentation

enum CorCoefReturnStatus_e

Enumerator:

CORCOEF_OK
CORCOEF_TOO_MANY_LAGS_ERROR
CORCOEF_CROSS_COR_ERROR
CORCOEF_STATS_ERROR
CORCOEF_UNDEFINED

enum StatsSuccessorFailure_e

Enumerator:

STATSSUCCESS
STATSFAILURE

---

Function Documentation

CorCoefReturnStatus CorCoef

(

CorCoefpacket *

ccpacketp

)

StatsSuccessorFailure stats	(	float *	x,
		int	n,
		float *	xbarp,
		float *	sigmap
	)

CorCoefReturnStatus Xcor

(

CorCoefpacket *

ccpacketp

)

---

Variable Documentation

const char* CorCoefErrorMessage[5] [static]

Initial value:

 
   { "CorCoef >> OK\n",
     "CorCoef>> Error - Too many lags requested.\n",
     "CorCoef>> Error - Cross Correlation routine returned error.\n",
     "CorCoef>> Error - Stats routine returned error\n",
     "CorCoef>> Error - Undefined - you shouldn't see this\n"}