CL-max_element

Functions
template<typename ForwardIterator >
ForwardIterator	bolt::cl::max_element (bolt::cl::control &ctl, ForwardIterator first, ForwardIterator last, const std::string &cl_code="")
	The max_element returns the location of the first maximum element in the specified range.
template<typename ForwardIterator >
ForwardIterator	bolt::cl::max_element (ForwardIterator first, ForwardIterator last, const std::string &cl_code="")
template<typename ForwardIterator , typename BinaryPredicate >
ForwardIterator	bolt::cl::max_element (bolt::cl::control &ctl, ForwardIterator first, ForwardIterator last, BinaryPredicate binary_op, const std::string &cl_code="")
	The max_element returns the location of the first maximum element in the specified range using the specified binary_op.
template<typename ForwardIterator , typename BinaryPredicate >
ForwardIterator	bolt::cl::max_element (ForwardIterator first, ForwardIterator last, BinaryPredicate binary_op, const std::string &cl_code="")

Detailed Description

Function Documentation

template<typename ForwardIterator >

ForwardIterator bolt::cl::max_element	(	bolt::cl::control &	ctl,
		ForwardIterator	first,
		ForwardIterator	last,
		const std::string &	cl_code = ""
	)

The max_element returns the location of the first maximum element in the specified range.

Parameters

ctl	Optional Control structure to control command-queue, debug, tuning.
first	A forward iterator addressing the position of the first element in the range to be searched for the maximum element
last	A forward iterator addressing the position one past the final element in the range to be searched for the maximum element
cl_code	Optional OpenCL(TM) code to be passed to the OpenCL compiler. The cl_code is inserted first in the generated code, before the cl_code trait.

Template Parameters

ForwardIterator

An iterator that can be dereferenced for an object, and can be incremented to get to the next element in a sequence.

Returns

The position of the max_element.

The following code example shows how to find the position of the max_element of 10 numbers, using the default BinaryPredicate which is bolt::cl::greater<T>().

#include <bolt/cl/max_element.h>

int a[10] = {4, 8, 6, 1, 5, 3, 10, 2, 9, 7};

int max_pos = bolt::cl::max_element(a, a+10);
// max_pos = 6

See Also

http://www.sgi.com/tech/stl/max_element.html

template<typename ForwardIterator , typename BinaryPredicate >

ForwardIterator bolt::cl::max_element	(	bolt::cl::control &	ctl,
		ForwardIterator	first,
		ForwardIterator	last,
		BinaryPredicate	binary_op,
		const std::string &	cl_code = ""
	)

The max_element returns the location of the first maximum element in the specified range using the specified binary_op.

Parameters

ctl	Optional Control structure to control command-queue, debug, tuning, etc. See bolt::cl::control.
first	A forward iterator addressing the position of the first element in the range to be searched for the maximum element
last	A forward iterator addressing the position one past the final element in the range to be searched for the maximum element
binary_op	The binary operation used to combine two values. By default, the binary operation is less<>().
cl_code	Optional OpenCL(TM) code to be passed to the OpenCL compiler. The cl_code is inserted first in the generated code, before the cl_code trait.

Template Parameters

ForwardIterator	An iterator that can be dereferenced for an object, and can be incremented to get to the next element in a sequence.
BinaryPredicate	A function object defining an operation that is applied to consecutive elements in the sequence.

Returns

The position of the max_element.

The following code example shows how to find the position of the max_element of 10 numbers, using the default greater operator.

#include <bolt/cl/max_element.h>

int a[10] = {4, 8, 6, 1, 5, 3, 10, 2, 9, 7};

int max_pos = bolt::cl::max_element(a, a+10, bolt::cl::greater<T>());
// max_pos = 6

See Also

http://www.sgi.com/tech/stl/max_element.html