Two (Euclidean) norm reduction operator: result = sqrt( sum( conj(v0[i])*v0[i], i=0...n-1 ) ).
More...
#include <RTOpPack_ROpNorm2.hpp>
Inheritance diagram for RTOpPack::ROpNorm2< Scalar >:
Public Types | |
| typedef Teuchos::ScalarTraits< Scalar > | ST |
 Public Types inherited from RTOpPack::ROp_1_ScalarReduction< Scalar, Scalar, ROpNorm2EleWiseReduction< Scalar > > | |
| typedef ROpScalarReductionWithOpBase< Scalar, Scalar, SumScalarReductObjReduction< Scalar > > | base_t |
| Public Types inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, Scalar, SumScalarReductObjReduction< Scalar > > | |
| 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 | |
| ROpNorm2 () | |
| ST::magnitudeType | operator() (const ReductTarget &reduct_obj) const |
| Public Member Functions inherited from RTOpPack::ROp_1_ScalarReduction< Scalar, Scalar, ROpNorm2EleWiseReduction< Scalar > > | |
| ROp_1_ScalarReduction (const Scalar &initReductObjValue_in=Scalar(), ROpNorm2EleWiseReduction< Scalar > eleWiseReduction_in=ROpNorm2EleWiseReduction< 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, Scalar, SumScalarReductObjReduction< Scalar > > | |
| ROpScalarReductionWithOpBase (const Scalar &initReductObjValue_in=ScalarTraits< Scalar >::zero(), SumScalarReductObjReduction< Scalar > reductObjReduction_in=SumScalarReductObjReduction< Scalar >()) | |
| const Scalar & | getRawVal (const ReductTarget &reduct_obj) const |
| void | setRawVal (const Scalar &rawVal, const Ptr< ReductTarget > &reduct_obj) const |
| Scalar | 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from RTOpPack::ROpScalarReductionWithOpBase< Scalar, Scalar, SumScalarReductObjReduction< Scalar > > | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (Scalar, 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 RTOpPack::ROpNorm2< Scalar >
Two (Euclidean) norm reduction operator: result = sqrt( sum( conj(v0[i])*v0[i], i=0...n-1 ) ).
Definition at line 68 of file RTOpPack_ROpNorm2.hpp.
Member Typedef Documentation
◆ ST
template<class Scalar >
| typedef Teuchos::ScalarTraits<Scalar> RTOpPack::ROpNorm2< Scalar >::ST |
Definition at line 73 of file RTOpPack_ROpNorm2.hpp.
Constructor & Destructor Documentation
◆ ROpNorm2()
template<class Scalar >
|
inline |
Definition at line 75 of file RTOpPack_ROpNorm2.hpp.
Member Function Documentation
◆ operator()()
template<class Scalar >
|
inline |
Definition at line 80 of file RTOpPack_ROpNorm2.hpp.
The documentation for this class was generated from the following file:
