mod

Compute \(x - n * y\) where n is quotient of \(x / y\). More...

Functions
AFAPI af_err	af_mod (af_array *out, const af_array lhs, const af_array rhs, const bool batch)
	C Interface for modulus. More...
AFAPI array	mod (const array &lhs, const array &rhs)
	C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar. More...
AFAPI array	mod (const array &lhs, const double rhs)
	C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar. More...
AFAPI array	mod (const double lhs, const array &rhs)
	C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar. More...
AFAPI array	operator% (const array &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. More...
AFAPI array	operator% (const bool &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const int &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const unsigned &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const char &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const unsigned char &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const long &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const unsigned long &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const long long &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const unsigned long long &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const double &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const float &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const cfloat &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const cdouble &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const bool &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const int &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const unsigned &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const char &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const unsigned char &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const long &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const unsigned long &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const long long &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const unsigned long long &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const double &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const float &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const cfloat &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const cdouble &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const short &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const unsigned short &lhs, const array &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const short &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...
AFAPI array	operator% (const array &lhs, const unsigned short &rhs)
	Performs an modulo operation on two arrays or an array and a value. (const array&, const array&) More...

Detailed Description

Compute \(x - n * y\) where n is quotient of \(x / y\).

Note

This function supports real inputs only. Complex inputs are not yet supported.

Function Documentation

AFAPI af_err af_mod	(	af_array *	out,
		const af_array	lhs,
		const af_array	rhs,
		const bool	batch
	)

C Interface for modulus.

Parameters

[out]	out	will contain the output of lhs modulo rhs
[in]	lhs	is dividend
[in]	rhs	is divisor
[in]	batch	specifies if operations need to be performed in batch mode

Returns

AF_SUCCESS if the execution completes properly

AFAPI array af::mod	(	const array &	lhs,
		const array &	rhs
	)

C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar.

Parameters

[in]	lhs	is dividend
[in]	rhs	is divisor

Returns

lhs modulo rhs

AFAPI array af::mod	(	const array &	lhs,
		const double	rhs
	)

C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar.

Parameters

[in]	lhs	is dividend
[in]	rhs	is divisor

Returns

lhs modulo rhs

AFAPI array af::mod	(	const double	lhs,
		const array &	rhs
	)

C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar.

Parameters

[in]	lhs	is dividend
[in]	rhs	is divisor

Returns

lhs modulo rhs

AFAPI array af::operator%	(	const short &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const cdouble &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const cfloat &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const float &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const double &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const unsigned long long &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const long long &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const unsigned long &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const long &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const unsigned char &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const char &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const unsigned &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const int &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const bool &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const cdouble &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const cfloat &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const float &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const double &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const unsigned long long &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const long long &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const unsigned long &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const long &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const unsigned char &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const char &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const unsigned &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const int &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const bool &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const short &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const unsigned short &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)

AFAPI array af::operator%	(	const array &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value.

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs

AFAPI array af::operator%	(	const unsigned short &	lhs,
		const array &	rhs
	)

Performs an modulo operation on two arrays or an array and a value. (const array&, const array&)

Parameters

[in]	lhs	the left hand side value of the operand
[in]	rhs	the right hand side value of the operand

Returns

an array with a modulo operation performed on each element of lhs and rhs (const array&, const array&)