Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Search for 

RTOpPack::ROpGetSubVector< Scalar > Class Template Reference

Reduction operator that extracts a sub-vector in the range of global indexes [l,u]. More...

#include <RTOpPack_ROpGetSubVector.hpp>

Inheritance diagram for RTOpPack::ROpGetSubVector< Scalar >:

[legend]
List of all members.

Overridden from RTOpT

void get_reduct_type_num_entries (int *num_values, int *num_indexes, int *num_chars) const
 
Teuchos::RefCountPtr< ReductTarget > reduct_obj_create () const
 
void reduce_reduct_objs (const ReductTarget &_in_reduct_obj, ReductTarget *_inout_reduct_obj) const
 
void reduct_obj_reinit (ReductTarget *reduct_obj) const
 
void extract_reduct_obj_state (const ReductTarget &reduct_obj, int num_values, primitive_value_type value_data[], int num_indexes, RTOp_index_type index_data[], int num_chars, RTOp_char_type char_data[]) const
 
void load_reduct_obj_state (int num_values, const primitive_value_type value_data[], int num_indexes, const RTOp_index_type index_data[], int num_chars, const RTOp_char_type char_data[], ReductTarget *reduct_obj) const
 
void get_op_type_num_entries (int *num_values, int *num_indexes, int *num_chars) const
 
void extract_op_state (int num_values, primitive_value_type value_data[], int num_indexes, RTOp_index_type index_data[], int num_chars, RTOp_char_type char_data[]) const
 
void load_op_state (int num_values, const primitive_value_type value_data[], int num_indexes, const RTOp_index_type index_data[], int num_chars, const RTOp_char_type char_data[])
 
bool coord_invariant () const
 
void apply_op (const int num_vecs, const SubVectorT< Scalar > sub_vecs[], const int num_targ_vecs, const MutableSubVectorT< Scalar > targ_sub_vecs[], ReductTarget *reduct_obj) const
 

Public Types

typedef RTOpT< Scalar >::primitive_value_type primitive_value_type
 

Public Member Functions

 ROpGetSubVector (const index_type l=0, const index_type u=0)
 
void set_range (const index_type l, const index_type u)
 Set the range of global indexes to extract elements for.
ReductTargetSubVectorT< Scalar > & operator() (ReductTarget &reduct_obj) const
 Extract the subvector after all of the reductions are completed.
const ReductTargetSubVectorT<
Scalar > & 		operator() (const ReductTarget &reduct_obj) const
 Extract the subvector after all of the reductions are completed.

Detailed Description

template<class Scalar>
class RTOpPack::ROpGetSubVector< Scalar >

Reduction operator that extracts a sub-vector in the range of global indexes [l,u].

ToDo: Finish documentation!

Definition at line 44 of file RTOpPack_ROpGetSubVector.hpp.

Member Typedef Documentation

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

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 48 of file RTOpPack_ROpGetSubVector.hpp.

Constructor & Destructor Documentation

template<class Scalar>
RTOpPack::ROpGetSubVector< Scalar >::ROpGetSubVector (  const index_type  l = 0,
const index_type  u = 0
) 
 

Definition at line 199 of file RTOpPack_ROpGetSubVector.hpp.

Member Function Documentation

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::set_range (  const index_type  l,
const index_type  u
) 
 

Set the range of global indexes to extract elements for.

Definition at line 204 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
ReductTargetSubVectorT< Scalar > & RTOpPack::ROpGetSubVector< Scalar >::operator() (  ReductTarget &  reduct_obj  )  const
 

Extract the subvector after all of the reductions are completed.

Definition at line 212 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
const ReductTargetSubVectorT< Scalar > & RTOpPack::ROpGetSubVector< Scalar >::operator() (  const ReductTarget &  reduct_obj  )  const
 

Extract the subvector after all of the reductions are completed.

Definition at line 220 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::get_reduct_type_num_entries (  int *  num_values,
int *  num_indexes,
int *  num_chars
)  const [virtual]
 

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 229 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
Teuchos::RefCountPtr< ReductTarget > RTOpPack::ROpGetSubVector< Scalar >::reduct_obj_create (   )  const [virtual]
 

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 243 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::reduce_reduct_objs (  const ReductTarget &  _in_reduct_obj,
ReductTarget *  _inout_reduct_obj
)  const [virtual]
 

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 249 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::reduct_obj_reinit (  ReductTarget *  reduct_obj  )  const [virtual]
 

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 267 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::extract_reduct_obj_state (  const ReductTarget &  reduct_obj,
int  num_values,
primitive_value_type  value_data[],
int  num_indexes,
RTOp_index_type  index_data[],
int  num_chars,
RTOp_char_type  char_data[]
)  const
 

Definition at line 274 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::load_reduct_obj_state (  int  num_values,
const primitive_value_type  value_data[],
int  num_indexes,
const RTOp_index_type  index_data[],
int  num_chars,
const RTOp_char_type  char_data[],
ReductTarget *  reduct_obj
)  const
 

Definition at line 294 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::get_op_type_num_entries (  int *  num_values,
int *  num_indexes,
int *  num_chars
)  const [virtual]
 

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 315 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::extract_op_state (  int  num_values,
primitive_value_type  value_data[],
int  num_indexes,
RTOp_index_type  index_data[],
int  num_chars,
RTOp_char_type  char_data[]
)  const
 

Definition at line 328 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::load_op_state (  int  num_values,
const primitive_value_type  value_data[],
int  num_indexes,
const RTOp_index_type  index_data[],
int  num_chars,
const RTOp_char_type  char_data[]
) 
 

Definition at line 344 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
bool RTOpPack::ROpGetSubVector< Scalar >::coord_invariant (   )  const [virtual]
 

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 360 of file RTOpPack_ROpGetSubVector.hpp.

template<class Scalar>
void RTOpPack::ROpGetSubVector< Scalar >::apply_op (  const int  num_vecs,
const SubVectorT< Scalar >  sub_vecs[],
const int  num_targ_vecs,
const MutableSubVectorT< Scalar >  targ_sub_vecs[],
ReductTarget *  reduct_obj
)  const [virtual]
 

Implements RTOpPack::RTOpT< Scalar >.

Definition at line 366 of file RTOpPack_ROpGetSubVector.hpp.

The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:39:44 2008 for RTOp : Vector Reduction/Transformation Operators by doxygen 1.3.9.1