SQFloatVector.h File Reference

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

Go to the source code of this file.

Classes
struct	tagSQ_FloatVector

Typedefs
typedef struct tagSQ_FloatVector *	SQ_FloatVector

Functions
SQ_ErrorCode	SQ_InitFloatVector (SQ_FloatVector *pVector, int iSize)
SQ_ErrorCode	SQ_CopyFloatVector (SQ_FloatVector pInVector, SQ_FloatVector *pOutVector)
SQ_ErrorCode	SQ_ClearFloatVector (SQ_FloatVector *pVector)
SQ_ErrorCode	SQ_SetDataInFloatVector (SQ_FloatVector pVector, int iPos, float fVal)
SQ_ErrorCode	SQ_GetDataFromFloatVector (const SQ_FloatVector pVector, int iPos, float *pfVal)
SQ_ErrorCode	SQ_SetFloatVector (SQ_FloatVector pVector, const float *pfVals)
SQ_ErrorCode	SQ_GetFloatVector (const SQ_FloatVector pVector, float *pfVals)
SQ_ErrorCode	SQ_GetFloatVectorSize (const SQ_FloatVector pVector, int *piSize)

Detailed Description

This file list the SQ_FloatVector object used in Umetrics SIMCA-Q products.

Typedef Documentation

SQ_FloatVector

typedef struct tagSQ_FloatVector * SQ_FloatVector

An int vector that is used to get and send data to many functions. Index base = 1. IMPORTANT: Always initialize it to NULL!

Function Documentation

SQ_ClearFloatVector()

SQ_ErrorCode SQ_ClearFloatVector

(

SQ_FloatVector *

pVector

)

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

See also

tagSQ_FloatVector

Parameters

[in]

pVector

The vector to be removed.

Returns

Returns SQ_E_OK if success or an error code

SQ_CopyFloatVector()

SQ_ErrorCode SQ_CopyFloatVector	(	SQ_FloatVector	pInVector,
		SQ_FloatVector *	pOutVector
	)

Get a copy of the float vector

See also

tagSQ_FloatVector

Parameters

[in]	pInVector	The vector to copy.
[in,out]	pOutVector	The result vector.

Returns

Returns SQ_E_OK if success or an error code

SQ_GetDataFromFloatVector()

SQ_ErrorCode SQ_GetDataFromFloatVector	(	const SQ_FloatVector	pVector,
		int	iPos,
		float *	pfVal
	)

Gets the data from a given position.

See also

tagSQ_FloatVector

Parameters

[in]	pVector	The vector to get the data from.
[in]	iPos	The position to get the data from.
[out]	pfVal	The data in the cell.

Returns

Returns SQ_E_OK if success or an error code

SQ_GetFloatVector()

SQ_ErrorCode SQ_GetFloatVector	(	const SQ_FloatVector	pVector,
		float *	pfVals
	)

Gets the data from the vector.

See also

tagSQ_FloatVector

Parameters

[in]	pVector	The vector to get the data from.
[out]	pfVals	An array to be filled with the data from the vector. Must be at least of same size as the vector.

Returns

Returns SQ_E_OK if success or an error code

SQ_GetFloatVectorSize()

SQ_ErrorCode SQ_GetFloatVectorSize	(	const SQ_FloatVector	pVector,
		int *	piSize
	)

Returns the size of the vector.

See also

tagSQ_FloatVector

Parameters

[in]	pVector	The vector to get the number of columns from.
[out]	piSize	The size of the vector or a negative number if an error occurred.

Returns

Returns SQ_E_OK if success or an error code

SQ_InitFloatVector()

SQ_ErrorCode SQ_InitFloatVector	(	SQ_FloatVector *	pVector,
		int	iSize
	)

Initialize an integer vector with its size.

See also

tagSQ_FloatVector

Parameters

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

Returns

Returns SQ_E_OK if success or an error code

SQ_SetDataInFloatVector()

SQ_ErrorCode SQ_SetDataInFloatVector	(	SQ_FloatVector	pVector,
		int	iPos,
		float	fVal
	)

Sets the data at the given position.

See also

tagSQ_FloatVector

Parameters

[in]	pVector	The vector to set the data in.
[in]	iPos	The position to set the data in.
[in]	fVal	The data to set the cell with.

Returns

Returns SQ_E_OK if success or an error code

SQ_SetFloatVector()

SQ_ErrorCode SQ_SetFloatVector	(	SQ_FloatVector	pVector,
		const float *	pfVals
	)

Sets the data in the vector.

See also

tagSQ_FloatVector

Parameters

[in]	pVector	The vector to set the data in.
[in]	pfVals	An array of data to fill the vector with. Must be at least of same size as the vector.

Returns

Returns SQ_E_OK if success or an error code