SQComponentVector.h File Reference

#include "SQDef.h"
#include "SQErrorCodes.h"

Go to the source code of this file.

Classes
struct	tagSQ_ComponentVector

Typedefs
typedef struct tagSQ_ComponentVector *	SQ_ComponentVector

Functions
SQ_ErrorCode	SQ_InitComponentVector (SQ_ComponentVector *pVector, int nSize)
SQ_ErrorCode	SQ_ClearComponentVector (SQ_ComponentVector *pVector)
SQ_ErrorCode	SQ_SetDataInComponentVector (SQ_ComponentVector pVector, int nPos, int iPredComp, int iXComp, int iYComp)
SQ_ErrorCode	SQ_GetDataFromComponentVector (SQ_ComponentVector pVector, int nPos, int *piPredComp, int *piXComp, int *piYComp)
SQ_ErrorCode	SQ_GetComponentVectorSize (SQ_ComponentVector pVector, int *piSize)

Detailed Description

This file contains the SQ_ComponentVector object used in Umetrics SIMCA-Q products.

Typedef Documentation

SQ_ComponentVector

typedef struct tagSQ_ComponentVector * SQ_ComponentVector

An int vector that is used to get and send data to many functions. Index base = 1.

Function Documentation

SQ_ClearComponentVector()

SQ_ErrorCode SQ_ClearComponentVector

(

SQ_ComponentVector *

pVector

)

Removes the vector, this function must be called for every vector that is created.

See also

tagSQ_ComponentVector

Parameters

[in]

pVector

The vector to be removed.

Returns

Returns SQ_E_OK if success or an error code

SQ_GetComponentVectorSize()

SQ_ErrorCode SQ_GetComponentVectorSize	(	SQ_ComponentVector	pVector,
		int *	piSize
	)

Returns the size of the vector.

See also

tagSQ_ComponentVector

Parameters

[in]	pVector	The vector to get the number of columns from.
[out]	piSize	The size of the vector.

Returns

Returns SQ_E_OK if success or an error code

SQ_GetDataFromComponentVector()

SQ_ErrorCode SQ_GetDataFromComponentVector	(	SQ_ComponentVector	pVector,
		int	nPos,
		int *	piPredComp,
		int *	piXComp,
		int *	piYComp
	)

Gets the data from a given position.

See also

tagSQ_ComponentVector

Parameters

[in]	pVector	The vector to get the data from.
[in]	nPos	The model or class to set number of components.
[out]	piPredComp	The prediction component. This is the only component for non O2PLS models.
[out]	piXComp	The X side component. O2PLS models only.
[out]	piYComp	The Y side component. O2PLS models only.

Returns

Returns SQ_E_OK if success or an error code

SQ_InitComponentVector()

SQ_ErrorCode SQ_InitComponentVector	(	SQ_ComponentVector *	pVector,
		int	nSize
	)

Initialize a component vector with its size.

See also

tagSQ_ComponentVector

Parameters

[in]	pVector	The vector to be initialized.
[in]	nSize	The size of the vector.

Returns

Returns SQ_E_OK if success or an error code

SQ_SetDataInComponentVector()

SQ_ErrorCode SQ_SetDataInComponentVector	(	SQ_ComponentVector	pVector,
		int	nPos,
		int	iPredComp,
		int	iXComp,
		int	iYComp
	)

Sets the data at the given position.

See also

tagSQ_ComponentVector

Parameters

[in]	pVector	The vector to set the data in.
[in]	nPos	The model or class to set number of components
[in]	iPredComp	The prediction component. This is the only component for non O2PLS models.
[in]	iXComp	The X side component. O2PLS models only.
[in]	iYComp	The Y side component. O2PLS models only.

Returns

Returns SQ_E_OK if success or an error code