fvec class
[FTS Data Classes]

---

Detailed Description

The fvec class.

Floating-point vector or reference to an fmat column, row or diagonal.

Typedefs
typedef struct fvec	fvec_t
	The fvec data type.
Functions
fmat_t *	fvec_get_fmat (fvec_t *fvec) enum fvec_type fvec_get_type(fvec_t *fvec)
	Get the fmat referenced by the fvec.
int	fvec_get_index (fvec_t *fvec)
	Get fvec column index (col) or row index (row) or row onset (diag).
int	fvec_get_onset (fvec_t *fvec)
	Get fvec row onset (col) or column onset (row) or column onset (diag).
int	fvec_get_raw_size (fvec_t *fvec)
	Get set fvec size regardless the fmat size.
void	fvec_set_type (fvec_t *fvec, enum fvec_type type)
	Set fvec type by type id.
void	fvec_set_index (fvec_t *fvec, int index)
	Set fvec column index (col) or row index (row) or row onset (diag).
void	fvec_set_onset (fvec_t *fvec, int onset)
	Set fvec row onset (col) or column onset (row) or column onset (diag).
void	fvec_set_size (fvec_t *fvec, int size)
	Set fvec size regardless the fmat size.
FTS_API void	fvec_set_fmat (fvec_t *fvec, fmat_t *fmat)
	Set fmat referenced by an fvec.
FTS_API fvec_t *	fvec_create_vector (int size)
	Create fvec vector.
FTS_API fvec_t *	fvec_create_column (fmat_t *fmat)
	Create fvec column.
FTS_API fvec_t *	fvec_create_row (fmat_t *fmat)
	Create fvec row.
FTS_API fvec_t *	fvec_create_diagonal (fmat_t *fmat)
	Create fvec diagonal.
FTS_API int	fvec_get_size (fvec_t *fvec)
	Get fmat real size.
FTS_API float	fvec_get_element (fvec_t *fvec, int i)
	Get fvec value at given index (with no checks).
FTS_API void	fvec_set_element (fvec_t *fvec, int i, float value)
	Set fvec value at given index (with no checks).
FTS_API void	fvec_set_dimensions (fvec_t *fvec, int ac, const fts_atom_t *at)
	Set fvec index, onset (optional) and size (optional) from an argument list.
FTS_API void	fvec_vector_lock (fvec_t *fvec, float **ptr, int *size, int *stride)
	Check class and get dimensions of an fvec vector.
void	fvec_unlock (fvec_t *fvec)
	Unlock an fvec after a previous lock.
Variables
FTS_API fts_class_t *	fvec_class
	The fvec class identifier (pointer to class instance).

---

Function Documentation

FTS_API fvec_t* fvec_create_column

(

fmat_t *

fmat

)

Create fvec column.

Parameters:

fmat

associated fmat

Returns:

pointer to created fvec

FTS_API fvec_t* fvec_create_diagonal

(

fmat_t *

fmat

)

Create fvec diagonal.

Parameters:

fmat

associated fmat

Returns:

pointer to created fvec

FTS_API fvec_t* fvec_create_row

(

fmat_t *

fmat

)

Create fvec row.

Parameters:

fmat

associated fmat

Returns:

pointer to created fvec

FTS_API fvec_t* fvec_create_vector

(

int

size

)

Create fvec vector.

quick create

Parameters:

size

vector size

Returns:

pointer to created fvec

FTS_API float fvec_get_element	(	fvec_t *	fvec,
		int	i
	)

Get fvec value at given index (with no checks).

get element, no checks

Parameters:

	fvec	the fvec
	i	the index

Returns:

element at given index

fmat_t* fvec_get_fmat

(

fvec_t *

fvec

)

Get the fmat referenced by the fvec.

Parameters:

fvec

the fvec

Returns:

fmat ....

Get the type of an fvec as type id.

Parameters:

fvec

the fvec

Returns:

fvec type id

int fvec_get_index

(

fvec_t *

fvec

)

Get fvec column index (col) or row index (row) or row onset (diag).

Parameters:

fvec

the fvec

Returns:

the index

int fvec_get_onset

(

fvec_t *

fvec

)

Get fvec row onset (col) or column onset (row) or column onset (diag).

Parameters:

fvec

the fvec

Returns:

the onset

int fvec_get_raw_size

(

fvec_t *

fvec

)

Get set fvec size regardless the fmat size.

Parameters:

fvec

the fvec

Returns:

the size

FTS_API int fvec_get_size

(

fvec_t *

fvec

)

Get fmat real size.

Parameters:

fvec

the fvec

Returns:

fvec size

FTS_API void fvec_set_dimensions	(	fvec_t *	fvec,
		int	ac,
		const fts_atom_t *	at
	)

Set fvec index, onset (optional) and size (optional) from an argument list.

Parameters:

	fvec	the fvec
	ac	argument count
	at	aguments

FTS_API void fvec_set_element	(	fvec_t *	fvec,
		int	i,
		float	value
	)

Set fvec value at given index (with no checks).

Parameters:

	fvec	the fvec
	i	the index
	value	new value

FTS_API void fvec_set_fmat	(	fvec_t *	fvec,
		fmat_t *	fmat
	)

Set fmat referenced by an fvec.

Parameters:

	fvec	the fvec
	fmat	new fmat

void fvec_set_index	(	fvec_t *	fvec,
		int	index
	)

Set fvec column index (col) or row index (row) or row onset (diag).

Parameters:

	fvec	the fvec
	index	new index

void fvec_set_onset	(	fvec_t *	fvec,
		int	onset
	)

Set fvec row onset (col) or column onset (row) or column onset (diag).

Parameters:

	fvec	the fvec
	onset	new onset

void fvec_set_size	(	fvec_t *	fvec,
		int	size
	)

Set fvec size regardless the fmat size.

Parameters:

	fvec	the fvec
	size	new size

void fvec_set_type	(	fvec_t *	fvec,
		enum fvec_type	type
	)

Set fvec type by type id.

Parameters:

	fvec	the fvec
	type	new type

void fvec_unlock

(

fvec_t *

fvec

)

Unlock an fvec after a previous lock.

This function has to be calles after a call to fvec_vector_lock().

Parameters:

fvec

the fvec

Returns:

pointer to raw float data vector

FTS_API void fvec_vector_lock	(	fvec_t *	fvec,
		float **	ptr,
		int *	size,
		int *	stride
	)

Check class and get dimensions of an fvec vector.

This function puts a shared lock (read lock) on the fvec. The fvec has be unlocked by a call to fvec_unlock().