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

Advanced transformation operator that assigns elements from a sparse explicit vector. More...

#include <RTOpPack_TOpSetSubVector.hpp>

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

Public Types

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

Overridden protected functions from RTOpT.

enum  { num_sub_vec_members = 6 }
 
SparseSubVectorT< Scalar > sub_vec_
 
bool coord_invariant_impl () const
 
void apply_op_impl (const ArrayView< const ConstSubVectorView< Scalar > > &sub_vecs, const ArrayView< const SubVectorView< Scalar > > &targ_sub_vecs, const Ptr< ReductTarget > &reduct_obj) const
 

Constructors/initializers.

 TOpSetSubVector ()
 
 TOpSetSubVector (const SparseSubVectorT< Scalar > &sub_vec)
 
void set_sub_vec (const SparseSubVectorT< Scalar > &sub_vec)
 

Additional Inherited Members

- 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.
 
- 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 void get_reduct_type_num_entries_impl (const Ptr< int > &num_values, const Ptr< int > &num_indexes, const Ptr< int > &num_chars) const
 
virtual 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
 
virtual void reduct_obj_reinit_impl (const Ptr< ReductTarget > &reduct_obj) const
 
virtual 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
 
virtual 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
 
virtual std::string op_name_impl () const
 
virtual Range1D range_impl () const
 

Detailed Description

template<class Scalar>
class RTOpPack::TOpSetSubVector< Scalar >

Advanced transformation operator that assigns elements from a sparse explicit vector.

ToDo: Finish documentation!

Definition at line 59 of file RTOpPack_TOpSetSubVector.hpp.

Member Typedef Documentation

◆ primitive_value_type

template<class Scalar >
typedef RTOpT<Scalar>::primitive_value_type RTOpPack::TOpSetSubVector< Scalar >::primitive_value_type

Definition at line 63 of file RTOpPack_TOpSetSubVector.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<class Scalar >
anonymous enum
private
Enumerator
num_sub_vec_members 

Definition at line 98 of file RTOpPack_TOpSetSubVector.hpp.

Constructor & Destructor Documentation

◆ TOpSetSubVector() [1/2]

template<class Scalar >
RTOpPack::TOpSetSubVector< Scalar >::TOpSetSubVector ( )

Definition at line 51 of file RTOpPack_TOpSetSubVector_def.hpp.

◆ TOpSetSubVector() [2/2]

template<class Scalar >
RTOpPack::TOpSetSubVector< Scalar >::TOpSetSubVector ( const SparseSubVectorT< Scalar > & sub_vec)

Definition at line 57 of file RTOpPack_TOpSetSubVector_def.hpp.

Member Function Documentation

◆ set_sub_vec()

template<class Scalar >
void RTOpPack::TOpSetSubVector< Scalar >::set_sub_vec ( const SparseSubVectorT< Scalar > & sub_vec)

Definition at line 65 of file RTOpPack_TOpSetSubVector_def.hpp.

◆ coord_invariant_impl()

template<class Scalar >
bool RTOpPack::TOpSetSubVector< Scalar >::coord_invariant_impl ( ) const
protectedvirtual

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 75 of file RTOpPack_TOpSetSubVector_def.hpp.

◆ apply_op_impl()

template<class Scalar >
void RTOpPack::TOpSetSubVector< Scalar >::apply_op_impl ( const ArrayView< const ConstSubVectorView< Scalar > > & sub_vecs,
const ArrayView< const SubVectorView< Scalar > > & targ_sub_vecs,
const Ptr< ReductTarget > & reduct_obj ) const
protectedvirtual

Implements RTOpPack::RTOpT< Scalar >.

Definition at line 82 of file RTOpPack_TOpSetSubVector_def.hpp.

Member Data Documentation

◆ sub_vec_

template<class Scalar >
SparseSubVectorT<Scalar> RTOpPack::TOpSetSubVector< Scalar >::sub_vec_
private

Definition at line 100 of file RTOpPack_TOpSetSubVector.hpp.


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