Teuchos version of MPI_MINLOC. More...

Inheritance diagram for Teuchos::MinLoc< Ordinal, ScalarType, IndexType >:

Public Member Functions
void	reduce (const Ordinal count, const std::pair< ScalarType, IndexType > inBuffer[], std::pair< ScalarType, IndexType > inoutBuffer[]) const

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
	Return a simple one-line description of this object. More...

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to a FancyOStream. More...

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Version of describe() that takes an std::ostream instead of a FancyOStream. More...

virtual	~Describable ()
	Destructor (marked virtual for memory safety of derived classes). More...

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
	Construct with an empty label. More...

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)
	Set the object label (see LabeledObject). More...

virtual std::string	getObjectLabel () const
	Get the object label (see LabeledObject). More...

Additional Inherited Members
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the `verbLevel` argument of describe(). More...

Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. More...

Detailed Description

template<class Ordinal, class ScalarType, class IndexType>
class Teuchos::MinLoc< Ordinal, ScalarType, IndexType >

Teuchos version of MPI_MINLOC.

Author: Mark Hoemmen

Template Parameters

Ordinal	The template parameter of `Comm`.
ScalarType	Type for which to find the minimum.
IndexType	Type indicating the index of the minimum.

MPI_MINLOC is a standard reduction operator provided by the MPI standard. According to the standard, MPI_MINLOC combines the (value, index) pairs (u,i) and (v,j) into (w,j), where $w = min(u,v)$ , and

$k = \begin{cases} i & \text{if $u < v$}, \\ \min(i,j) & \text{if $u = v$}, \\ j & \text{if $u > v$}. \\ \end{cases}$

This class implements the MPI_MINLOC reduction operator for the Teuchos communication wrappers.

Refer to the note in the documentation of MaxLoc that explains how we adjust the above definition to produce well-defined results even if the array contains a NaN.

Definition at line 141 of file Teuchos_TimeMonitor.cpp.

Member Function Documentation

template<class Ordinal , class ScalarType , class IndexType >

void Teuchos::MinLoc< Ordinal, ScalarType, IndexType >::reduce	(	const Ordinal	count,
		const std::pair< ScalarType, IndexType >	inBuffer[],
		std::pair< ScalarType, IndexType >	inoutBuffer[]
	)		const

virtual

Implements Teuchos::ValueTypeReductionOp< Ordinal, std::pair< ScalarType, IndexType > >.

The documentation for this class was generated from the following file:

Teuchos_TimeMonitor.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Ordinal, class ScalarType, class IndexType> class Teuchos::MinLoc< Ordinal, ScalarType, IndexType >

Member Function Documentation

template<class Ordinal, class ScalarType, class IndexType>
class Teuchos::MinLoc< Ordinal, ScalarType, IndexType >