RTOp Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
RTOpPack::ROpWeightedNorm2< Scalar > Class Template Reference

Weighted Two (Euclidean) norm reduction operator: result = sqrt( sum( v0[i]*conj(v1[i])*v1[i], i=0...n-1 ) ). More...

#include <RTOpPack_ROpWeightedNorm2.hpp>

Inheritance diagram for RTOpPack::ROpWeightedNorm2< Scalar >:
Inheritance graph
[legend]

Public Types

typedef Teuchos::ScalarTraits< Scalar > ST
 
- Public Types inherited from RTOpPack::ROp_2_ScalarReduction< Scalar, Scalar, ROpWeightedNorm2EleWiseReduction< Scalar > >
typedef ROpScalarReductionWithOpBase< Scalar, Scalar, SumScalarReductObjReduction< Scalar > > base_t
 
- Public Types inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, ConcreteReductObj, 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

 ROpWeightedNorm2 ()
 
ST::magnitudeType operator() (const ReductTarget &reduct_obj) const
 
- Public Member Functions inherited from RTOpPack::ROp_2_ScalarReduction< Scalar, Scalar, ROpWeightedNorm2EleWiseReduction< Scalar > >
 ROp_2_ScalarReduction (const Scalar &initReductObjValue_in=Scalar(), ROpWeightedNorm2EleWiseReduction< Scalar > eleWiseReduction_in=ROpWeightedNorm2EleWiseReduction< Scalar >(), SumScalarReductObjReduction< Scalar > reductObjReduction_in=SumScalarReductObjReduction< Scalar >())
 
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
 
- Public Member Functions inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, ConcreteReductObj, ReductObjReduction >
 ROpScalarReductionWithOpBase (const ConcreteReductObj &initReductObjValue_in=ScalarTraits< Scalar >::zero(), ReductObjReduction reductObjReduction_in=ReductObjReduction())
 
const ConcreteReductObj & getRawVal (const ReductTarget &reduct_obj) const
 
void setRawVal (const ConcreteReductObj &rawVal, const Ptr< ReductTarget > &reduct_obj) const
 
ConcreteReductObj 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< ReductTargetreduct_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.
 
Teuchos::RCP< ReductTargetreduct_obj_create () const
 Creates a new reduction target object initialized and ready to be used in a reduction.
 
void reduce_reduct_objs (const ReductTarget &in_reduct_obj, const Ptr< ReductTarget > &inout_reduct_obj) const
 Reduce intermediate reduction target objects.
 
void reduct_obj_reinit (const Ptr< ReductTarget > &reduct_obj) const
 Reinitialize an already created reduction object.
 
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.
 
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.
 
std::string op_name () const
 Return the name (as a null-terminated C-style string) of the operator.
 
bool coord_invariant () const
 Returns true if this operator is coordinate invariant.
 
Range1D range () const
 Returns the continuous range of elements that this operator is defined over.
 
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.
 

Additional Inherited Members

- Protected Member Functions inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, ConcreteReductObj, ReductObjReduction >
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ConcreteReductObj, initReductObjValue)
 
- Protected Member Functions inherited from RTOpPack::RTOpT< Scalar >
 RTOpT (const std::string &op_name_base="")
 Constructor that creates an operator name appended with the type.
 
void setOpNameBase (const std::string &op_name_base)
 Just set the operator name.
 
virtual std::string op_name_impl () const
 
virtual bool coord_invariant_impl () const
 
virtual Range1D range_impl () const
 

Detailed Description

template<class Scalar>
class RTOpPack::ROpWeightedNorm2< Scalar >

Weighted Two (Euclidean) norm reduction operator: result = sqrt( sum( v0[i]*conj(v1[i])*v1[i], i=0...n-1 ) ).

Definition at line 68 of file RTOpPack_ROpWeightedNorm2.hpp.

Member Typedef Documentation

◆ ST

template<class Scalar >
typedef Teuchos::ScalarTraits<Scalar> RTOpPack::ROpWeightedNorm2< Scalar >::ST

Definition at line 74 of file RTOpPack_ROpWeightedNorm2.hpp.

Constructor & Destructor Documentation

◆ ROpWeightedNorm2()

template<class Scalar >
RTOpPack::ROpWeightedNorm2< Scalar >::ROpWeightedNorm2 ( )
inline

Definition at line 76 of file RTOpPack_ROpWeightedNorm2.hpp.

Member Function Documentation

◆ operator()()

template<class Scalar >
ST::magnitudeType RTOpPack::ROpWeightedNorm2< Scalar >::operator() ( const ReductTarget & reduct_obj) const
inline

Definition at line 81 of file RTOpPack_ROpWeightedNorm2.hpp.


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