Internal Matrix API

The Internal Matrix API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::Matrix::Matrix (vx_context context, vx_reference scope)
	Construct a new Matrix object.
	coreflow::Matrix::Matrix (vx_context context, vx_type_e type, vx_reference scope)
	Construct a new Matrix object.
static vx_matrix	coreflow::Matrix::createMatrix (vx_context context, vx_enum data_type, vx_size columns, vx_size rows)
	Create a matrix object.
vx_enum	coreflow::Matrix::dataType () const
	Get the data type of the matrix.
vx_size	coreflow::Matrix::numRows () const
	Get the number of rows in the matrix.
vx_size	coreflow::Matrix::numCols () const
	Get the number of columns in the matrix.
vx_coordinates2d_t	coreflow::Matrix::originCoord () const
	Get the origin coordinates of the matrix.
vx_enum	coreflow::Matrix::patternType () const
	Get the pattern type of the matrix.
vx_status	coreflow::Matrix::read (void *array)
	Read the matrix data into an array.
vx_status	coreflow::Matrix::write (const void *array)
	Write the matrix data from an array.
vx_status	coreflow::Matrix::copy (void *ptr, vx_enum usage, vx_enum mem_type)
	Copy the matrix data to/from a pointer.
	coreflow::Matrix::~Matrix ()
	Destroy the Matrix object.
void	coreflow::Matrix::destruct () override
	Destroys a matrix objects.

Detailed Description

The Internal Matrix API.

Function Documentation

copy()

vx_status coreflow::Matrix::copy	(	void *	ptr,
		vx_enum	usage,
		vx_enum	mem_type )

#include <vx_matrix.h>

Copy the matrix data to/from a pointer.

Parameters

ptr	The pointer to copy the matrix data to/from.
usage	The usage flags for the memory operation.
mem_type	The type of memory used (e.g., OpenCL buffer).

Returns

vx_status The status of the operation.

createMatrix()

static vx_matrix coreflow::Matrix::createMatrix ( vx_context context, vx_enum data_type, vx_size columns, vx_size rows )

static

#include <vx_matrix.h>

Create a matrix object.

Parameters

context	The context associated with this obj
data_type	The data type of the matrix
columns	The number of columns in the matrix
rows	The number of rows in the matrix

Returns

vx_matrix The matrix object

dataType()

vx_enum coreflow::Matrix::dataType

(

)

const

#include <vx_matrix.h>

Get the data type of the matrix.

Returns

vx_enum The data type of the matrix

destruct()

void coreflow::Matrix::destruct ( )

overridevirtual

#include <vx_matrix.h>

Destroys a matrix objects.

Reimplemented from coreflow::Reference.

Matrix() [1/2]

coreflow::Matrix::Matrix	(	vx_context	context,
		vx_reference	scope )

#include <vx_matrix.h>

Construct a new Matrix object.

Parameters

context	The context associated with this obj
scope	The parent ref of this obj

Matrix() [2/2]

coreflow::Matrix::Matrix	(	vx_context	context,
		vx_type_e	type,
		vx_reference	scope )

#include <vx_matrix.h>

Construct a new Matrix object.

Parameters

context	The context associated with this obj
type	The data type of matrix
scope	The parent ref of this obj

numCols()

vx_size coreflow::Matrix::numCols

(

)

const

#include <vx_matrix.h>

Get the number of columns in the matrix.

Returns

vx_size The number of columns in the matrix.

numRows()

vx_size coreflow::Matrix::numRows

(

)

const

#include <vx_matrix.h>

Get the number of rows in the matrix.

Returns

vx_size The number of rows in the matrix.

originCoord()

vx_coordinates2d_t coreflow::Matrix::originCoord

(

)

const

#include <vx_matrix.h>

Get the origin coordinates of the matrix.

Returns

vx_coordinates2d_t The origin coordinates of the matrix.

patternType()

vx_enum coreflow::Matrix::patternType

(

)

const

#include <vx_matrix.h>

Get the pattern type of the matrix.

Returns

vx_enum The pattern type of the matrix.

read()

vx_status coreflow::Matrix::read

(

void *

array

)

#include <vx_matrix.h>

Read the matrix data into an array.

Parameters

array

The array to read the matrix data into.

Returns

vx_status The status of the operation.

write()

vx_status coreflow::Matrix::write

(

const void *

array

)

#include <vx_matrix.h>

Write the matrix data from an array.

Parameters

array

The array containing the matrix data to write.

Returns

vx_status The status of the operation.

~Matrix()

coreflow::Matrix::~Matrix

(

)

#include <vx_matrix.h>

Destroy the Matrix object.