array.h File Reference

Array. More...

#include "generic.h"

Include dependency graph for array.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_VlArray
	Numeric array. More...
Defines
#define	VL_ARRAY_MAX_NUM_DIMENSIONS   16
	Maximum number of array dimensions.
Typedefs
typedef struct _VlArray	VlArray
	Numeric array.
Functions
Get data and parameters
VL_INLINE vl_size	vl_array_get_num_dimensions (VlArray const *self)
	Get number of dimensions.
VL_INLINE vl_size const *	vl_array_get_dimensions (VlArray const *self)
	Get dimensions.
VL_INLINE void *	vl_array_get_data (VlArray const *self)
	Get data.
VL_INLINE vl_type	vl_array_get_data_type (VlArray const *self)
	Get type.
VL_EXPORT vl_size	vl_array_get_num_elements (VlArray const *self)
	Get number of elements in array.
Constructing and destroying
VL_EXPORT VlArray *	vl_array_init (VlArray *self, vl_type type, vl_size numDimension, vl_size const *dimensions)
	New numeric array.
VL_EXPORT VlArray *	vl_array_init_envelope (VlArray *self, void *data, vl_type type, vl_size numDimension, vl_size const *dimensions)
	New numeric array envelope.
VL_EXPORT VlArray *	vl_array_init_matrix (VlArray *self, vl_type type, vl_size numRows, vl_size numColumns)
	New numeric array with matrix shape.
VL_EXPORT VlArray *	vl_array_init_matrix_envelope (VlArray *self, void *data, vl_type type, vl_size numRows, vl_size numColumns)
	New numeric array envelpe with matrix shape.
VL_EXPORT VlArray *	vl_array_new (vl_type type, vl_size numDimension, vl_size const *dimensions)
	New numeric array.
VL_EXPORT VlArray *	vl_array_new_envelope (void *data, vl_type type, vl_size numDimension, vl_size const *dimensions)
	New numeric array envelope.
VL_EXPORT VlArray *	vl_array_new_matrix (vl_type type, vl_size numRows, vl_size numColumns)
	New numeric array with matrix shape.
VL_EXPORT VlArray *	vl_array_new_matrix_envelope (void *data, vl_type type, vl_size numRows, vl_size numColumns)
	New numeric array envelpe with matrix shape.
VL_EXPORT void	vl_array_dealloc (VlArray *self)
	Delete array.
VL_EXPORT void	vl_array_delete (VlArray *self)
	Delete array.

---

Detailed Description

Array.

Array - Definition.

Author:

Andrea Vedaldi

Definition in file array.h.

---

Define Documentation

#define VL_ARRAY_MAX_NUM_DIMENSIONS   16

Maximum number of array dimensions.

Definition at line 20 of file array.h.

---

Typedef Documentation

typedef struct _VlArray VlArray

Numeric array.

---

Function Documentation

VL_EXPORT void vl_array_dealloc

(

VlArray *

self

)

Delete array.

Parameters:

self

array.

Definition at line 124 of file array.c.

VL_EXPORT void vl_array_delete

(

VlArray *

self

)

Delete array.

Parameters:

self

array.

Definition at line 202 of file array.c.

VL_INLINE void* vl_array_get_data

(

VlArray const *

self

)

Get data.

Parameters:

self

array.

Returns:

data.

Definition at line 67 of file array.h.

VL_INLINE vl_type vl_array_get_data_type

(

VlArray const *

self

)

Get type.

Parameters:

self

array.

Returns:

type.

Definition at line 78 of file array.h.

VL_INLINE vl_size const* vl_array_get_dimensions

(

VlArray const *

self

)

Get dimensions.

Parameters:

self

array.

Returns:

dimensions.

Definition at line 56 of file array.h.

VL_INLINE vl_size vl_array_get_num_dimensions

(

VlArray const *

self

)

Get number of dimensions.

Parameters:

self

array.

Returns:

number of dimensions.

Definition at line 45 of file array.h.

VL_EXPORT vl_size vl_array_get_num_elements

(

VlArray const *

self

)

Get number of elements in array.

Parameters:

self

array.

Returns:

number of elements.

Definition at line 23 of file array.c.

VL_EXPORT VlArray* vl_array_init	(	VlArray *	self,
		vl_type	type,
		vl_size	numDimensions,
		vl_size const *	dimensions
	)

New numeric array.

Parameters:

self	array to initialize.
type	data type.
numDimensions	number of dimensions.
dimensions	dimensions.

The function initializes the specified array and allocates the necessary memory for storage.

Definition at line 51 of file array.c.

VL_EXPORT VlArray* vl_array_init_envelope	(	VlArray *	self,
		void *	data,
		vl_type	type,
		vl_size	numDimensions,
		vl_size const *	dimensions
	)

New numeric array envelope.

Parameters:

self	array to initialize.
data	data to envelople.
type	data type.
numDimensions	number of dimensions.
dimensions	dimensions.

The function initializes the specified array wrapping the specified buffer.

Definition at line 76 of file array.c.

VL_EXPORT VlArray* vl_array_init_matrix	(	VlArray *	self,
		vl_type	type,
		vl_size	numRows,
		vl_size	numColumns
	)

New numeric array with matrix shape.

Parameters:

self	array to initialize.
type	type.
numRows	number of rows.
numColumns	number of columns.

Definition at line 97 of file array.c.

VL_EXPORT VlArray* vl_array_init_matrix_envelope	(	VlArray *	self,
		void *	data,
		vl_type	type,
		vl_size	numRows,
		vl_size	numColumns
	)

New numeric array envelpe with matrix shape.

Parameters:

self	array to initialize.
data	data to envelope.
type	type.
numRows	number of rows.
numColumns	number of columns.

Definition at line 112 of file array.c.

VL_EXPORT VlArray* vl_array_new	(	vl_type	type,
		vl_size	numDimensions,
		vl_size const *	dimensions
	)

New numeric array.

Parameters:

type	data type.
numDimensions	number of dimensions.
dimensions	dimensions.

The function creates a new VLArray instance and allocates the necessary memory for storage.

Definition at line 149 of file array.c.

VL_EXPORT VlArray* vl_array_new_envelope	(	void *	data,
		vl_type	type,
		vl_size	numDimensions,
		vl_size const *	dimensions
	)

New numeric array envelope.

Parameters:

data	data to envelople.
type	data type.
numDimensions	number of dimensions.
dimensions	dimensions.

Definition at line 176 of file array.c.

VL_EXPORT VlArray* vl_array_new_matrix	(	vl_type	type,
		vl_size	numRows,
		vl_size	numColumns
	)

New numeric array with matrix shape.

Parameters:

type	type.
numRows	number of rows.
numColumns	number of columns.

Definition at line 162 of file array.c.

VL_EXPORT VlArray* vl_array_new_matrix_envelope	(	void *	data,
		vl_type	type,
		vl_size	numRows,
		vl_size	numColumns
	)

New numeric array envelpe with matrix shape.

Parameters:

data	data to envelope.
type	type.
numRows	number of rows.
numColumns	number of columns.

Definition at line 191 of file array.c.