Base class for scalar reduction RTOps with two input vectors. More...

#include <RTOpPack_RTOpTHelpers_decl.hpp>

Inheritance diagram for RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >:

Public Types
typedef ROpScalarReductionWithOpBase < Scalar, ReductScalar, ReductObjReduction >	base_t

Public Types inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, ReductScalar, ReductObjReduction >
typedef RTOpT< Scalar > ::primitive_value_type	primitive_value_type

Public Types inherited from RTOpPack::RTOpT< Scalar >
typedef PrimitiveTypeTraits < Scalar, Scalar > ::primitiveType	primitive_value_type

Public Member Functions
	ROp_2_ScalarReduction (const ReductScalar &initReductObjValue_in=ReductScalar(), EleWiseReduction eleWiseReduction_in=EleWiseReduction(), ReductObjReduction reductObjReduction_in=ReductObjReduction())

Public Member Functions inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, ReductScalar, ReductObjReduction >
	ROpScalarReductionWithOpBase (const ReductScalar &initReductObjValue_in=ScalarTraits< Scalar >::zero(), ReductObjReduction reductObjReduction_in=ReductObjReduction())

const ReductScalar &	getRawVal (const ReductTarget &reduct_obj) const

void	setRawVal (const ReductScalar &rawVal, const Ptr< ReductTarget > &reduct_obj) const

ReductScalar	operator() (const ReductTarget &reduct_obj) const

void	get_reduct_type_num_entries_impl (const Ptr< int > &num_values, const Ptr< int > &num_indexes, const Ptr< int > &num_chars) const

Teuchos::RCP< ReductTarget >	reduct_obj_create_impl () const

virtual void	reduce_reduct_objs_impl (const ReductTarget &in_reduct_obj, const Ptr< ReductTarget > &inout_reduct_obj) const

void	reduct_obj_reinit_impl (const Ptr< ReductTarget > &reduct_obj) const

void	extract_reduct_obj_state_impl (const ReductTarget &reduct_obj, const ArrayView< primitive_value_type > &value_data, const ArrayView< index_type > &index_data, const ArrayView< char_type > &char_data) const

void	load_reduct_obj_state_impl (const ArrayView< const primitive_value_type > &value_data, const ArrayView< const index_type > &index_data, const ArrayView< const char_type > &char_data, const Ptr< ReductTarget > &reduct_obj) const

Public Member Functions inherited from RTOpPack::RTOpT< Scalar >
void	get_reduct_type_num_entries (const Ptr< int > &num_values, const Ptr< int > &num_indexes, const Ptr< int > &num_chars) const
	Get the number of entries of each basic data type in the externalized state for a reduction object for this operator. More...

Teuchos::RCP< ReductTarget >	reduct_obj_create () const
	Creates a new reduction target object initialized and ready to be used in a reduction. More...

void	reduce_reduct_objs (const ReductTarget &in_reduct_obj, const Ptr< ReductTarget > &inout_reduct_obj) const
	Reduce intermediate reduction target objects. More...

void	reduct_obj_reinit (const Ptr< ReductTarget > &reduct_obj) const
	Reinitialize an already created reduction object. More...

void	extract_reduct_obj_state (const ReductTarget &reduct_obj, const ArrayView< primitive_value_type > &value_data, const ArrayView< index_type > &index_data, const ArrayView< char_type > &char_data) const
	Extract the state of an already created reduction object. More...

void	load_reduct_obj_state (const ArrayView< const primitive_value_type > &value_data, const ArrayView< const index_type > &index_data, const ArrayView< const char_type > &char_data, const Ptr< ReductTarget > &reduct_obj) const
	Load the state of an already created reduction object given arrays of primitive objects. More...

std::string	op_name () const
	Return the name (as a null-terminated C-style string) of the operator. More...

bool	coord_invariant () const
	Returns `true` if this operator is coordinate invariant. More...

Range1D	range () const
	Returns the continuous range of elements that this operator is defined over. More...

void	apply_op (const ArrayView< const ConstSubVectorView< Scalar > > &sub_vecs, const ArrayView< const SubVectorView< Scalar > > &targ_sub_vecs, const Ptr< ReductTarget > &reduct_obj) const
	Apply the reduction/transformation operator to a set of sub-vectors. More...

Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

Private Attributes
EleWiseReduction	eleWiseReduction_

Overridden from RTOpT
void	apply_op_impl (const ArrayView< const ConstSubVectorView< Scalar > > &sub_vecs, const ArrayView< const SubVectorView< Scalar > > &targ_sub_vecs, const Ptr< ReductTarget > &reduct_obj_inout) const

Additional Inherited Members
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, ReductScalar, ReductObjReduction >
	STANDARD_MEMBER_COMPOSITION_MEMBERS (ReductScalar, initReductObjValue)

Protected Member Functions inherited from RTOpPack::RTOpT< Scalar >
virtual std::string	op_name_impl () const

virtual bool	coord_invariant_impl () const

virtual Range1D	range_impl () const

	RTOpT (const std::string &op_name_base="")
	Constructor that creates an operator name appended with the type. More...

void	setOpNameBase (const std::string &op_name_base)
	Just set the operator name. More...

Detailed Description

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>>
class RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >

Base class for scalar reduction RTOps with two input vectors.

Definition at line 676 of file RTOpPack_RTOpTHelpers_decl.hpp.

Member Typedef Documentation

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>>

typedef ROpScalarReductionWithOpBase<Scalar, ReductScalar, ReductObjReduction> RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >::base_t

Definition at line 683 of file RTOpPack_RTOpTHelpers_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>>

RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >::ROp_2_ScalarReduction	(	const ReductScalar &	initReductObjValue_in = `ReductScalar()`,
		EleWiseReduction	eleWiseReduction_in = `EleWiseReduction()`,
		ReductObjReduction	reductObjReduction_in = `ReductObjReduction()`
	)

inline

Definition at line 686 of file RTOpPack_RTOpTHelpers_decl.hpp.

Member Function Documentation

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>>

void RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >::apply_op_impl	(	const ArrayView< const ConstSubVectorView< Scalar > > &	sub_vecs,
		const ArrayView< const SubVectorView< Scalar > > &	targ_sub_vecs,
		const Ptr< ReductTarget > &	reduct_obj_inout
	)		const

inlinevirtual

Implements RTOpPack::RTOpT< Scalar >.

Definition at line 699 of file RTOpPack_RTOpTHelpers_decl.hpp.

Member Data Documentation

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>>

EleWiseReduction RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >::eleWiseReduction_

private

Definition at line 743 of file RTOpPack_RTOpTHelpers_decl.hpp.

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

RTOpPack_RTOpTHelpers_decl.hpp

Public Types

Public Member Functions

Private Attributes

Overridden from RTOpT

Additional Inherited Members

Detailed Description

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>> class RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar, class ReductScalar, class EleWiseReduction, class ReductObjReduction = SumScalarReductObjReduction<ReductScalar>>
class RTOpPack::ROp_2_ScalarReduction< Scalar, ReductScalar, EleWiseReduction, ReductObjReduction >