min

Return the minimum along a given dimension. More...

Functions
AFAPI array	min (const array &in, const int dim=-1)
	C++ Interface to return the minimum along a given dimension. More...
template<typename T >
T	min (const array &in)
	C++ Interface to return the minimum along the first non-singleton dimension. More...
AFAPI void	min (array &val, array &idx, const array &in, const int dim=-1)
	C++ Interface to return the minimum and its location along a given dimension. More...
template<typename T >
void	min (T *val, unsigned *idx, const array &in)
	C++ Interface to return the minimum and its location over all dimensions. More...
AFAPI af_err	af_min (af_array *out, const af_array in, const int dim)
	C Interface to return the minimum along a given dimension. More...
AFAPI af_err	af_min_all (double *real, double *imag, const af_array in)
	C Interface to return the minimum over all dimensions. More...
AFAPI af_err	af_min_all_array (af_array *out, const af_array in)
	C Interface to return the minimum over all dimensions. More...
AFAPI af_err	af_imin (af_array *out, af_array *idx, const af_array in, const int dim)
	C Interface to return the minimum and its location along a given dimension. More...
AFAPI af_err	af_imin_all (double *real, double *imag, unsigned *idx, const af_array in)
	C Interface to return the minimum and its location over all dimensions. More...

Detailed Description

Return the minimum along a given dimension.

This function runs across all batches in the input simultaneously.

Function Documentation

af_imin()

AFAPI af_err af_imin	(	af_array *	out,
		af_array *	idx,
		const af_array	in,
		const int	dim
	)

C Interface to return the minimum and its location along a given dimension.

Parameters

[out]	out	minimum
[out]	idx	location
[in]	in	input array
[in]	dim	dimension along which the minimum is found

Returns

AF_SUCCESS, if function returns successfully, else an af_err code is given

af_imin_all()

AFAPI af_err af_imin_all	(	double *	real,
		double *	imag,
		unsigned *	idx,
		const af_array	in
	)

C Interface to return the minimum and its location over all dimensions.

NaN values are ignored.

Parameters

[out]	real	real component of the minimum
[out]	imag	imaginary component of the minimum; 0 if idx is real
[out]	idx	location
[in]	in	input array

Returns

AF_SUCCESS, if function returns successfully, else an af_err code is given

af_min()

AFAPI af_err af_min	(	af_array *	out,
		const af_array	in,
		const int	dim
	)

C Interface to return the minimum along a given dimension.

Parameters

[out]	out	minimum
[in]	in	input array
[in]	dim	dimension along which the minimum is found

Returns

AF_SUCCESS, if function returns successfully, else an af_err code is given

af_min_all()

AFAPI af_err af_min_all	(	double *	real,
		double *	imag,
		const af_array	in
	)

C Interface to return the minimum over all dimensions.

If in is real, imag will be set to zeros.

Parameters

[out]	real	real component of the minimum
[out]	imag	imaginary component of the minimum
[in]	in	input array

Returns

AF_SUCCESS, if function returns successfully, else an af_err code is given

af_min_all_array()

AFAPI af_err af_min_all_array	(	af_array *	out,
		const af_array	in
	)

C Interface to return the minimum over all dimensions.

Parameters

[out]	out	minimum
[in]	in	input array

Returns

AF_SUCCESS, if function returns successfully, else an af_err code is given

min() [1/4]

AFAPI void min	(	array &	val,
		array &	idx,
		const array &	in,
		const int	dim = -1
	)

C++ Interface to return the minimum and its location along a given dimension.

NaN values are ignored.

Parameters

[out]	val	minimum
[out]	idx	location
[in]	in	input array
[in]	dim	dimension along which the minimum is found, -1 denotes the first non-singleton dimension

min() [2/4]

T min

(

const array &

in

)

C++ Interface to return the minimum along the first non-singleton dimension.

NaN values are ignored.

Parameters

[in]

in

input array

Returns

minimum

min() [3/4]

AFAPI array min	(	const array &	in,
		const int	dim = -1
	)

C++ Interface to return the minimum along a given dimension.

NaN values are ignored.

Parameters

[in]	in	input array
[in]	dim	dimension along which the minimum is found, -1 denotes the first non-singleton dimension

Returns

minimum

min() [4/4]

void min	(	T *	val,
		unsigned *	idx,
		const array &	in
	)

C++ Interface to return the minimum and its location over all dimensions.

NaN values are ignored.

Often used to return values directly to the host.

Parameters

[out]	val	minimum
[out]	idx	location
[in]	in	input array