dot

Calculate the dot product of a vector. More...

Functions
AFAPI array	dot (const array &lhs, const array &rhs, const matProp optLhs=AF_MAT_NONE, const matProp optRhs=AF_MAT_NONE)
	Dot Product. More...
AFAPI af_err	af_dot (af_array *out, const af_array lhs, const af_array rhs, const af_mat_prop optLhs, const af_mat_prop optRhs)
	Scalar dot product between two vectors. More...

Detailed Description

Calculate the dot product of a vector.

Scalar dot product between two vectors. Also referred to as the inner product.

This function returns the scalar product of two equal sized vectors or between a matrix and a vector. The second operand needs to be a vector in either case.

---

Function Documentation

AFAPI af_err af_dot	(	af_array *	out,
		const af_array	lhs,
		const af_array	rhs,
		const af_mat_prop	optLhs,
		const af_mat_prop	optRhs
	)

Scalar dot product between two vectors.

Also referred to as the inner product.

// compute scalar dot product
array x = randu(100), y = randu(100);
print(dot<float>(x,y));

AFAPI array af::dot	(	const array &	lhs,
		const array &	rhs,
		const matProp	optLhs = AF_MAT_NONE,
		const matProp	optRhs = AF_MAT_NONE
	)

Dot Product.

Scalar dot product between two vectors. Also referred to as the inner product.

// compute scalar dot product
array x = randu(100), y = randu(100);
af_print(dot(x,y));

Parameters

[in]	lhs	The array object on the left hand side
[in]	rhs	The array object on the right hand side
[in]	optLhs	Options for lhs. Currently only AF_MAT_NONE and AF_MAT_CONJ are supported.
[in]	optRhs	Options for rhs. Currently only AF_MAT_NONE and AF_MAT_CONJ are supported

Returns

The result of the dot product of lhs, rhs

Note

optLhs and optRhs can only be one of AF_MAT_NONE or AF_MAT_CONJ

optLhs = AF_MAT_CONJ and optRhs = AF_MAT_NONE will run conjugate dot operation.

This function is not supported in GFOR

Returns

out = dot(lhs, rhs)