EpetraExt::Perm_traits< T > Struct Template Reference

List of all members.

Static Public Member Functions

const char * typeName ()
T * clone (T *example, Epetra_DataAccess CV, const Epetra_BlockMap &map, int int_argument)
void replaceMap (T *obj, const Epetra_BlockMap &map)
T * produceColumnPermutation (Permutation< T > *perm, T *srcObj)

Detailed Description

template<class T>
struct EpetraExt::Perm_traits< T >

Define some traits to make it easier to deal with template-parameters which are objects to be permuted. Given a template parameter, we'll want to have the following operations available:

First the default definition, which catches all types "T", followed by some specializations for anticipated types. Any type other than the types specifically anticipated will be handled by this default definition, allowing the Permutation class to abort or return NULL where appropriate.

We define these trait structs in this file rather than in a separate file in an attempt to avoid some template-instantiation complications...


Member Function Documentation

template<class T>
T* EpetraExt::Perm_traits< T >::clone T *  example,
Epetra_DataAccess  CV,
const Epetra_BlockMap map,
int  int_argument
[inline, static]
 

clone function accepts an example of the object being cloned, and enough constructor arguments to be able to create any of these: CrsMatrix, CrsGraph, Vector, MultiVector. And probably more later...

Why is an example object needed? For instance, if a MultiVector is created, we may want to know how many vectors it should contain...

template<class T>
T* EpetraExt::Perm_traits< T >::produceColumnPermutation Permutation< T > *  perm,
T *  srcObj
[inline, static]
 

return new object, which is a column-permutation of srcObj

template<class T>
void EpetraExt::Perm_traits< T >::replaceMap T *  obj,
const Epetra_BlockMap map
[inline, static]
 

replace the object's row-map (or if it's not a matrix, replace its only map)

template<class T>
const char* EpetraExt::Perm_traits< T >::typeName  )  [inline, static]
 

return a string name for the object type


The documentation for this struct was generated from the following file:
Generated on Thu Sep 18 12:43:01 2008 for EpetraExt by doxygen 1.3.9.1