Teuchos Namespace Reference
[Utility code for synchronizing std::exception detection across processors.]

The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines. More...


Classes

class  AbstractFactory
 Simple, universal "Abstract Factory" interface for the dynamic creation of objects. More...
class  PostModNothing
 Default post-modification policy class for AbstractFactorStd which does nothing! More...
class  AllocatorNew
 Default allocation policy class for AbstractFactoryStd which returns new T_impl(). More...
class  AbstractFactoryStd
 Simple, templated concrete subclass of universal "Abstract Factory" interface for the creation of objects. More...
class  any
 Modified boost::any class, which is a container for a templated value. More...
class  bad_any_cast
 Thrown if any_cast is attempted between two incompatable types. More...
class  InvalidArrayStringRepresentation
  More...
class  Array
 Array is a templated array class derived from the STL std::vector, but with index boundschecking and an extended interface. More...
class  ArrayArg
 Utility class that allows arrays to be passed into argument list. More...
class  ArrayRCP
 Array reference-counted pointer class. More...
class  TypeNameTraits< ArrayRCP< T > >
 Traits specialization. More...
class  ValueTypeConversionTraits
 Default traits class for all conversions of value types. More...
class  basic_oblackholestream
 basic_ostream<> subclass that does nothing but discard output. More...
class  BLAS
 The Templated BLAS Wrapper Class. More...
class  Comm
 Abstract interface class for a basic communication channel between one or more processes. More...
class  CommandLineProcessor
 Class that helps parse command line input arguments from (argc,argv[]) and set options. More...
class  SumValueReductionOp
 Standard summation operator for types with value semantics. More...
class  MinValueReductionOp
 Standard min operator for types with value semantics. More...
class  MaxValueReductionOp
 Standard Max operator for types with value semantics. More...
class  ANDValueReductionOp
 Standard logical AND operator for booleans. More...
class  CompileTimeAssert
 If instantiated (for Test!=0) then this should not compile! More...
class  CompileTimeAssert< 0 >
 If instantiated (i.e. Test==0) then this will compile! More...
class  CompObject
 Functionality and data that is common to all computational classes. More...
class  ConstNonconstObjectContainer
 Simple class for containing an object and protecting const with a runtime check which throws an std::exception. More...
class  DefaultComm
 Returns a default global communicator appropriate for the enviroment. More...
class  MpiComm
 Concrete communicator subclass based on MPI. More...
class  SerialComm
 Concrete serial communicator subclass. More...
class  Describable
 Base class for all objects that can describe themselves and their current state. More...
struct  DescribableStreamManipulatorState
class  m_bad_cast
 Exception class for bad cast. More...
class  ErrorPolling
 ErrorPolling provides utilities for establishing agreement between processors on whether an std::exception has been detected on any one processor. More...
class  basic_FancyOStream_buf
 Stream buffering class that performs the magic of indenting data sent to an std::ostream object. More...
class  basic_FancyOStream
 std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among other things. More...
class  basic_OSTab
 Tabbing class for helping to create formated, indented output for a basic_FancyOStream object. More...
class  FileInputSource
 Instantiation of XMLInputSource class for reading XML from a file. More...
class  FileInputStream
 Instantiation of XMLInputStream class for reading an entire document from a file. More...
class  FILEstream
 Teuchos::FILEstream: Combined C FILE and C++ stream. More...
class  Flops
 The Teuchos Floating Point Operations Class. More...
class  GlobalMPISession
 This class provides methods for initializing, finalizing, and querying the global MPI session. More...
class  ConstHandle
 Templated handle class with strong const protection. More...
class  Handle
 Generic templated handle class. More...
class  ConstHandleable
 Class ConstHandleable provides an abstract interface for polymorphic conversion from raw pointers to const smart pointers. More...
class  Handleable
 Class Handleable provides an abstract interface for polymorphic conversion from raw pointers to smart pointers. More...
class  HashSet
 Templated hashtable-based set. More...
class  HashPair
 Helper class for Teuchos::Hashtable, representing a single <key, value> pair. More...
class  Hashtable
 Templated hashtable class. More...
class  HashUtils
 Utilities for generating hashcodes. More...
class  LabeledObject
 Base class for objects that contain a std::string label. More...
struct  UndefinedLAPACKRoutine
class  LAPACK
 The Templated LAPACK Wrapper Class. More...
class  MPIComm
 Object representation of an MPI communicator. More...
class  MPIContainerComm
 Object representation of an MPI communicator for templated containers. More...
class  MpiReductionOpBase
 Base class for an MPI-compatible reduction operator. More...
class  MpiReductionOp
 Standard subclass implementation for MpiReductionOpBase in terms of a templated ReductionOp<Ordinal,char> object. More...
class  MpiReductionOpSetter
 Utility class for setting an MPI-compatible reduction object and using it to create an MPI_Op object. More...
class  MPISession
 This class provides methods for initializing, finalizing, and querying the global MPI session. More...
class  MPITraits
 Templated traits class that binds MPI types to C++ types. More...
class  Object
 The base Teuchos class. More...
class  OpaqueWrapper
 Base class for wrapped opaque objects. More...
class  OpaqueWrapperWithFree
 Subclass for wrapped opaque objects with a free function. More...
struct  UndefinedOrdinalTraits
struct  OrdinalTraits
 This structure defines some basic traits for the ordinal field type. More...
class  ParameterEntry
 This object is held as the "value" in the Teuchos::ParameterList std::map. More...
class  ParameterEntryValidator
 Abstract interface for an object that can validate a ParameterEntry's value. More...
class  ParameterList
 Templated parameter list. More...
class  TypeNameTraits< ParameterList >
 Traits specialization. More...
class  ParameterListAcceptor
 Base class objects that can accept a parameter list. More...
class  ParameterListAcceptorDefaultBase
 Intermediate node base class for objects that accept parameter lists that implements some of the needed behavior automatically. More...
class  ParameterListNonAcceptor
 Mix-in implementation subclass to be inherited by concrete subclasses who's interface says that they take a parameter list but do not have any parameters yet. More...
class  ParameterXMLFileReader
class  PerformanceMonitorBase
 Provides common capabilities for collecting and reporting performance data across processors. More...
class  PerformanceMonitorUtils
 Provides common capabilities for collecting and reporting performance data across processors. More...
class  Polynomial
 Lightweight container class to represent a simple polynomial. More...
class  PolynomialTraits
 Traits class for polynomial coefficients in Teuchos::Polynomial. More...
class  PrimitiveTypeTraits
 A templated traits class for decomposing object into an array of primitive objects. More...
class  PromotionTraits
class  PromotionTraits< T, T >
class  Range1D
 Subregion Index Range Class. More...
class  RawMPITraits
 Templated traits class that allows a datatype to be used with MPI that MPI can directly handle. More...
class  DeallocBoostSharedPtr
 Teuchos::RCP Deallocator class that wraps a boost::shared_ptr More...
class  RCPDeleter
 boost::shared_ptr deleter class that wraps a Teuchos::RCP. More...
class  RCP
 Smart reference counting pointer class for automatic garbage collection. More...
class  TypeNameTraits< RCP< T > >
 Traits specialization. More...
class  DeallocDelete
 Policy class for deallocator that uses delete to delete a pointer which is used by RCP. More...
class  DeallocArrayDelete
 Deallocator class that uses delete [] to delete memory allocated uisng new []. More...
class  DeallocFunctorDelete
 Deallocator subclass that Allows any functor object (including a function pointer) to be used to free an object. More...
class  DeallocFunctorHandleDelete
 Deallocator subclass that Allows any functor object (including a function pointer) to be used to free a handle (i.e. pointer to pointer) to an object. More...
class  ValueTypeReductionOp
 Base interface class for user-defined reduction operations for objects that use value semantics. More...
class  ReferenceTypeReductionOp
 Base interface class for user-defined reduction operations for objects that use reference semantics. More...
class  CharToValueTypeReductionOp
 Decorator class that uses traits to convert to and from char[] to typed buffers for objects that use value semantics and then call a type-specific reduction object. More...
class  CharToReferenceTypeReductionOp
 Decorator class that uses a strategy object to convert to and from char[] to typed buffers for objects that use reference semantics and then call a type-specific reduction object. More...
struct  UndefinedScalarTraits
struct  ScalarTraits
 This structure defines some basic traits for a scalar field type. More...
class  SerialDenseMatrix
 This class creates and provides basic support for dense rectangular matrix of templated type. More...
class  SerialDenseVector
 This class creates and provides basic support for dense vectors of templated type as a specialization of Teuchos::SerialDenseMatrix. Additional methods for the SerialDenseVector class, like mathematical methods, can be found documented in SerialDenseMatrix. More...
struct  UndefinedSerializationTraits
class  SerializationTraits
 Serialization traits class for types that use value semantics. More...
class  DirectSerializationTraits
class  SerializationTraits< Ordinal, char >
class  SerializationTraits< Ordinal, int >
class  SerializationTraits< Ordinal, float >
class  SerializationTraits< Ordinal, double >
class  ValueTypeSerializationBuffer
 Encapsulate how an array of non-const objects with value sematics is serialized into a char[] array. More...
class  ConstValueTypeSerializationBuffer
 Encapsulate how an array of const objects with value sematics is serialized into a const char[] array. More...
class  ValueTypeDeserializationBuffer
 Encapsulate how an array of non-const serialized objects with value sematics stored in a char[] array is deserialized to a T[] array and then serialized back again. More...
class  ConstValueTypeDeserializationBuffer
 Encapsulate how an array of non-const serialized objects with value sematics stored in a char[] array is deserialized to a T[] array and then serialized back again. More...
class  Serializer
 Strategy interface for the indirect serializing and deserializing objects of a given type handled using reference semantics. More...
class  ReferenceTypeSerializationBuffer
 Encapsulate how an array of non-const objects with reference sematics is serialized into a char[] array and deserialized again. More...
class  ConstReferenceTypeSerializationBuffer
 Encapsulate how an array of const objects with reference sematics is serialized into a char[] array. More...
class  ReferenceTypeDeserializationBuffer
 Encapsulate how an array of non-const objects with reference sematics is deserialized from a char[] array and then serialized back into the char[] buffer again. More...
class  ConstReferenceTypeDeserializationBuffer
 Encapsulate how an array of onst objects with reference sematics is deserialized from a char[] array with memory being automatically freed at destruction time. More...
class  StringToIntegralParameterEntryValidator
 Standard implementation of a ParameterEntryValidator that maps from a list of strings to some integral type value. More...
class  AnyNumberParameterEntryValidator
 Standard implementation of a ParameterEntryValidator that accepts numbers from a number of different formats and converts them to numbers in another format. More...
class  StringInputSource
 Instantiation of XMLInputSource class for reading XML from a std::string. More...
class  StringInputStream
 Instantiation of XMLInputStream for reading an entire document from a std::string. More...
class  StringToIntMap
 Map a std::string to an enumeration. More...
class  StrUtils
 Provides std::string manipulation utilities that are not provided in the standard C++ std::string class. More...
class  TableColumn
class  TableEntry
 An entry, perhaps compound, to be written into a table. More...
class  DoubleEntry
 A table entry that is a simple double-precision number. More...
class  IntEntry
 A table entry that is a simple integer. More...
class  StringEntry
 A table entry that is a simple std::string. More...
class  CompoundEntryWithParentheses
 An entry containing two subentries, with the second to be written in parentheses after the first. For example,. More...
class  TableFormat
 Encapsulation of formatting specifications for writing data in a clean tabular form. More...
class  Time
 Basic wall-clock timer class. More...
class  TimeMonitor
 A timer class that starts when constructed and stops when the destructor is called. More...
class  TreeBuildingXMLHandler
 TreeBuildingXMLHandler assembles a XMLObject from your XML input. More...
class  TypeNameTraits
 Default traits class that just returns typeid(T).name(). More...
class  TypeNameTraits< T * >
class  Utils
 This class provides some basic std::string and floating-point utilities for Teuchos. More...
class  VerboseObjectBase
 Non-templated base class for objects that can print their activities to a stream. More...
class  VerboseObject
 Templated base class for objects that can print their activities to a stream and have a verbosity level. More...
class  VerboseObjectTempState
 Set and release a stream and verbosity level. More...
class  RawWorkspace
 Encapulsation object for raw temporary workspace that has been allocated. These objects can only be created on the stack and should not be included as the member of any other classes. More...
class  Workspace
 Templated class for workspace creation. More...
class  WorkspaceStore
 Workspace encapsulation class. More...
class  WorkspaceStoreInitializeable
 WorkspaceStore class that can be used to actually reinitialize memory. More...
class  XMLInputSource
 XMLInputSource represents a source of XML input that can be parsed to produce an XMLObject. More...
class  XMLInputStream
 XMLInputStream represents an XML input stream that can be used by a XMLInputSource. More...
class  EmptyXMLError
 Thrown when attempting to parse an empty XML std::string. More...
class  XMLObject
 Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object, allowing storage by reference. More...
class  XMLObjectImplem
 The XMLObjectImplem class takes care of the low-level implementation details of XMLObject. More...
class  XMLParameterListReader
 Writes an XML object to a parameter list. More...
class  XMLParameterListWriter
 Writes a ParameterList to an XML object. More...
class  XMLParser
 XMLParser consumes characters from an XMLInputStream object, parsing the XML and using a TreeBuildingXMLHandler to construct an XMLObject. More...
class  TypeNameTraits< std::string >
class  TypeNameTraits< std::vector< T > >

Namespaces

namespace  Utilities
namespace  MixMaxUtilities
namespace  Exceptions
namespace  PrivateUtilityPack

Typedefs

typedef basic_FancyOStream<
char > 
FancyOStream
 
typedef basic_OSTab< char > OSTab
 
typedef basic_oblackholestream<
char, std::char_traits< char > > 
oblackholestream
 

Enumerations

enum  ESide { LEFT_SIDE, RIGHT_SIDE }
enum  ETransp { NO_TRANS, TRANS, CONJ_TRANS }
enum  EUplo { UPPER_TRI, LOWER_TRI }
enum  EDiag { UNIT_DIAG, NON_UNIT_DIAG }
enum  EReductionType { REDUCE_SUM, REDUCE_MIN, REDUCE_MAX, REDUCE_AND }
 Enumeration for selecting from a set of pre-defined reduction operations. More...
enum  DataAccess { Copy, View }
enum  EValidateUsed
  More...
enum  EValidateDefaults
  More...
enum  EMetricReduction
 Types of reduction operations on performance metrics. Add other operations if you like. More...
enum  ENull
 Used to initialize a RCP object to NULL using an implicit conversion! More...
enum  EPrePostDestruction
 Used to specify a pre or post destruction of extra data. More...
enum  EVerbosityLevel {
  VERB_DEFAULT = -1, VERB_NONE = 0, VERB_LOW = 1, VERB_MEDIUM = 2,
  VERB_HIGH = 3, VERB_EXTREME = 4
}
 Verbosity level. More...

Functions

template<class T>
std::ostream & operator<< (std::ostream &os, const Array< T > &array)
template<class T>
int hashCode (const Array< T > &array)
template<class T>
ArrayArg< 1, T > arrayArg (T t1)
 Return an array with 1 member.
template<class T>
ArrayArg< 2, T > arrayArg (T t1, T t2)
 Return an array with 2 members.
template<class T>
ArrayArg< 3, T > arrayArg (T t1, T t2, T t3)
 Return an array with 3 members.
template<class T>
ArrayArg< 4, T > arrayArg (T t1, T t2, T t3, T t4)
 Return an array with 4 members.
template<class T>
ArrayArg< 5, T > arrayArg (T t1, T t2, T t3, T t4, T t5)
 Return an array with 5 members.
template<class T>
ArrayArg< 6, T > arrayArg (T t1, T t2, T t3, T t4, T t5, T t6)
 Return an array with 6 members.
template<class T>
Teuchos::ArrayRCP< T > arcp (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, bool owns_mem)
template<class T, class Dealloc_T>
Teuchos::ArrayRCP< T > arcp (T *p, typename ArrayRCP< T >::Ordinal lowerOffset, typename ArrayRCP< T >::Ordinal size, Dealloc_T dealloc, bool owns_mem)
template<class T>
Teuchos::ArrayRCP< T > arcp (typename ArrayRCP< T >::Ordinal size)
template<class T>
REFCOUNTPTR_INLINE Teuchos::ArrayRCP<
T > 
arcp (const RCP< std::vector< T > > &v)
template<class T>
REFCOUNTPTR_INLINE Teuchos::RCP<
std::vector< T > > 
get_std_vector (const ArrayRCP< T > &ptr)
template<class T>
REFCOUNTPTR_INLINE Teuchos::ArrayRCP<
const T > 
arcp (const RCP< const std::vector< T > > &v)
template<class T>
REFCOUNTPTR_INLINE Teuchos::RCP<
const std::vector< T > > 
get_std_vector (const ArrayRCP< const T > &ptr)
template<class T>
REFCOUNTPTR_INLINE bool is_null (const ArrayRCP< T > &p)
template<class T>
REFCOUNTPTR_INLINE bool operator== (const ArrayRCP< T > &p, ENull)
template<class T>
REFCOUNTPTR_INLINE bool operator!= (const ArrayRCP< T > &p, ENull)
template<class T1, class T2>
REFCOUNTPTR_INLINE bool operator== (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
template<class T1, class T2>
REFCOUNTPTR_INLINE bool operator!= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
template<class T1, class T2>
REFCOUNTPTR_INLINE bool operator< (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
template<class T1, class T2>
REFCOUNTPTR_INLINE bool operator<= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
template<class T1, class T2>
REFCOUNTPTR_INLINE bool operator> (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
template<class T1, class T2>
REFCOUNTPTR_INLINE bool operator>= (const ArrayRCP< T1 > &p1, const ArrayRCP< T2 > &p2)
template<class T2, class T1>
REFCOUNTPTR_INLINE Teuchos::ArrayRCP<
T2 > 
arcp_reinterpret_cast (const ArrayRCP< T1 > &p1)
template<class T2, class T1>
REFCOUNTPTR_INLINE Teuchos::ArrayRCP<
T2 > 
arcp_implicit_cast (const ArrayRCP< T1 > &p1)
template<class T1, class T2>
REFCOUNTPTR_INLINE void set_extra_data (const T1 &extra_data, const std::string &name, Teuchos::ArrayRCP< T2 > *p, EPrePostDestruction destroy_when, bool force_unique)
template<class T1, class T2>
REFCOUNTPTR_INLINE T1 & get_extra_data (ArrayRCP< T2 > &p, const std::string &name)
template<class T1, class T2>
REFCOUNTPTR_INLINE const T1 & get_extra_data (const ArrayRCP< T2 > &p, const std::string &name)
template<class T1, class T2>
REFCOUNTPTR_INLINE T1 * get_optional_extra_data (ArrayRCP< T2 > &p, const std::string &name)
template<class T1, class T2>
REFCOUNTPTR_INLINE const T1 * get_optional_extra_data (const ArrayRCP< T2 > &p, const std::string &name)
template<class Dealloc_T, class T>
REFCOUNTPTR_INLINE Dealloc_T & get_dealloc (ArrayRCP< T > &p)
template<class Dealloc_T, class T>
const Dealloc_T & get_dealloc (const Teuchos::ArrayRCP< T > &p)
template<class Dealloc_T, class T>
REFCOUNTPTR_INLINE Dealloc_T * get_optional_dealloc (ArrayRCP< T > &p)
template<class Dealloc_T, class T>
const Dealloc_T * get_optional_dealloc (const Teuchos::ArrayRCP< T > &p)
template<class T>
std::ostream & operator<< (std::ostream &out, const ArrayRCP< T > &p)
template<class TypeTo, class TypeFrom>
TypeTo as (const TypeFrom &t)
 Perform an debug-enabled checked conversion from one value type object to another.
template<class TypeTo, class TypeFrom>
TypeTo asSafe (const TypeFrom &t)
 Perform an always checked conversion from one value type object to another.
template<typename Ordinal, typename Packet>
ValueTypeReductionOp< Ordinal,
Packet > * 
createOp (const EReductionType reductType)
template<typename Ordinal>
int rank (const Comm< Ordinal > &comm)
template<typename Ordinal>
int size (const Comm< Ordinal > &comm)
template<typename Ordinal>
void barrier (const Comm< Ordinal > &comm)
template<typename Ordinal, typename Packet>
void broadcast (const Comm< Ordinal > &comm, const int rootRank, const Ordinal count, Packet buffer[])
template<typename Ordinal, typename Packet>
void broadcast (const Comm< Ordinal > &comm, const int rootRank, Packet *object)
template<typename Ordinal, typename Packet>
void broadcast (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const int rootRank, const Ordinal count, Packet *const buffer[])
template<typename Ordinal, typename Packet>
void gatherAll (const Comm< Ordinal > &comm, const Ordinal sendCount, const Packet sendBuffer[], const Ordinal recvCount, Packet recvBuffer[])
template<typename Ordinal, typename Packet>
void gatherAll (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const Ordinal sendCount, const Packet *const sendBuffer[], const Ordinal recvCount, Packet *const recvBuffer[])
template<typename Ordinal, typename Packet>
void reduceAll (const Comm< Ordinal > &comm, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet sendBuffer[], Packet globalReducts[])
template<typename Ordinal, typename Packet>
void reduceAll (const Comm< Ordinal > &comm, const EReductionType reductType, const Ordinal count, const Packet sendBuffer[], Packet globalReducts[])
template<typename Ordinal, typename Packet>
void reduceAll (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *globalReduct)
template<typename Ordinal, typename Packet>
void reduceAll (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const ReferenceTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet *const sendBuffer[], Packet *const globalReducts[])
template<typename Ordinal, typename Packet>
void reduceAllAndScatter (const Comm< Ordinal > &comm, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal sendCount, const Packet sendBuffer[], const Ordinal recvCounts[], Packet myGlobalReducts[])
template<typename Ordinal, typename Packet>
void reduceAllAndScatter (const Comm< Ordinal > &comm, const EReductionType reductType, const Ordinal sendCount, const Packet sendBuffer[], const Ordinal recvCounts[], Packet myGlobalReducts[])
template<typename Ordinal, typename Packet>
void reduceAllAndScatter (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const ReferenceTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal sendCount, const Packet *const sendBuffer[], const Ordinal recvCounts[], Packet *const myGlobalReducts[])
template<typename Ordinal, typename Packet>
void scan (const Comm< Ordinal > &comm, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet sendBuffer[], Packet scanReducts[])
template<typename Ordinal, typename Packet>
void scan (const Comm< Ordinal > &comm, const EReductionType reductType, const Ordinal count, const Packet sendBuffer[], Packet scanReducts[])
template<typename Ordinal, typename Packet>
void scan (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *globalReduct)
template<typename Ordinal, typename Packet>
void scan (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const ReferenceTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet *const sendBuffer[], Packet *const scanReducts[])
template<typename Ordinal, typename Packet>
void send (const Comm< Ordinal > &comm, const Ordinal count, const Packet sendBuffer[], const int destRank)
template<typename Ordinal, typename Packet>
void send (const Comm< Ordinal > &comm, const Packet &send, const int destRank)
template<typename Ordinal, typename Packet>
void send (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const Ordinal count, const Packet *const sendBuffer[], const int destRank)
template<typename Ordinal, typename Packet>
int receive (const Comm< Ordinal > &comm, const int sourceRank, const Ordinal count, Packet recvBuffer[])
template<typename Ordinal, typename Packet>
int receive (const Comm< Ordinal > &comm, const int sourceRank, Packet *recv)
template<typename Ordinal, typename Packet>
int receive (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const int sourceRank, const Ordinal count, Packet *const recvBuffer[])
template<typename Ordinal>
Teuchos::RCP< Teuchos::MpiComm<
Ordinal > > 
createMpiComm (const RCP< const OpaqueWrapper< MPI_Comm > > &rawMpiComm)
void dyn_cast_throw_exception (const std::string &T_from, const std::string &T_from_concr, const std::string &T_to)
template<class T_To, class T_From>
T_To & dyn_cast (T_From &from)
 Dynamic casting utility function meant to replace dynamic_cast<T&> by throwing a better documented error message.
void doFloatingPointTrap (bool enableTrap)
 Turn on or off a floating point trap.
template<class T>
const T & getConst (T &t)
 Return a constant reference to an object given a non-const reference.
template<class Key>
std::string toString (const HashSet< Key > &h)
template<class Key>
std::ostream & operator<< (std::ostream &os, const HashSet< Key > &h)
template<class Key, class Value>
std::string toString (const Hashtable< Key, Value > &h)
template<class Key, class Value>
std::ostream & operator<< (std::ostream &os, const Hashtable< Key, Value > &h)
template<class TypeTo, class TypeFrom>
TypeTo implicit_cast (const TypeFrom &t)
 Perform an implicit cast of concrete types with the casted object returned by value.
template<class TypeTo, class TypeFrom>
TypeTo & implicit_ref_cast (TypeFrom &t)
 Perform an implicit cast of reference types with a reference being returned.
template<class TypeTo, class TypeFrom>
TypeTo * implicit_ptr_cast (TypeFrom *t)
 Perform an implicit cast of pointer types with a pointer being returned.
template<typename Ordinal>
RCP< const MpiReductionOp<
Ordinal > > 
mpiReductionOp (const RCP< const ValueTypeReductionOp< Ordinal, char > > &reductOp)
 Create an MpiReductionOp object given an ReductionOp object.
bool operator== (const ParameterList &list1, const ParameterList &list2)
bool haveSameValues (const ParameterList &list1, const ParameterList &list2)
RCP< ParameterListparameterList ()
 Nonmember constructor.
RCP< ParameterListparameterList (const std::string &name)
 Nonmember constructor.
RCP< ParameterListparameterList (const ParameterList &source)
 Nonmember constructor.
void print_active_RCP_nodes (std::ostream &out)
template<class T>
Teuchos::RCP< T > rcp (const boost::shared_ptr< T > &sptr)
 Conversion function that takes in a boost::shared_ptr object and spits out a Teuchos::RCP object.
template<class T>
boost::shared_ptr< T > shared_pointer (const RCP< T > &rcp)
 Conversion function that takes in a Teuchos::RCP object and spits out a boost::shared_ptr object.
void throwScalarTraitsNanInfError (const std::string &errMsg)
std::string getVerbosityLevelParameterValueName (const EVerbosityLevel verbLevel)
Teuchos::RCP< Teuchos::StringToIntegralParameterEntryValidator<
Teuchos::EVerbosityLevel > > 
verbosityLevelParameterEntryValidator (std::string const &defaultParameterName)
Teuchos::RCP< Teuchos::AnyNumberParameterEntryValidatoranyNumberParameterEntryValidator (AnyNumberParameterEntryValidator::EPreferredType const preferredType, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes)
void setIntParameter (std::string const &paramName, int const value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes)
void setDoubleParameter (std::string const &paramName, double const &value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes)
void setNumericStringParameter (std::string const &paramName, std::string const &value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes)
int getIntParameter (ParameterList const &paramList, std::string const &paramName)
double getDoubleParameter (ParameterList const &paramList, std::string const &paramName)
std::string getNumericStringParameter (ParameterList const &paramList, std::string const &paramName)
template<class IntegralType>
RCP< const StringToIntegralParameterEntryValidator<
IntegralType > > 
getStringToIntegralParameterEntryValidator (ParameterEntry const &entry, ParameterList const &paramList, std::string const &paramName)
 Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object.
template<class IntegralType>
Teuchos::RCP< Teuchos::StringToIntegralParameterEntryValidator<
IntegralType > > 
stringToIntegralParameterEntryValidator (Array< std::string > const &strings, std::string const &defaultParameterName)
template<class IntegralType>
Teuchos::RCP< Teuchos::StringToIntegralParameterEntryValidator<
IntegralType > > 
stringToIntegralParameterEntryValidator (Array< std::string > const &strings, Array< IntegralType > const &integralValues, std::string const &defaultParameterName)
template<class IntegralType>
Teuchos::RCP< Teuchos::StringToIntegralParameterEntryValidator<
IntegralType > > 
stringToIntegralParameterEntryValidator (Array< std::string > const &strings, Array< std::string > const &stringsDocs, Array< IntegralType > const &integralValues, std::string const &defaultParameterName)
template<class IntegralType>
void setStringToIntegralParameter (std::string const &paramName, std::string const &defaultValue, std::string const &docString, Array< std::string > const &strings, ParameterList *paramList)
template<class IntegralType>
void setStringToIntegralParameter (std::string const &paramName, std::string const &defaultValue, std::string const &docString, Array< std::string > const &strings, Array< IntegralType > const &integralValues, ParameterList *paramList)
template<class IntegralType>
void setStringToIntegralParameter (std::string const &paramName, std::string const &defaultValue, std::string const &docString, Array< std::string > const &strings, Array< std::string > const &stringsDocs, Array< IntegralType > const &integralValues, ParameterList *paramList)
template<class IntegralType>
IntegralType getIntegralValue (ParameterList const &paramList, std::string const &paramName)
template<class IntegralType>
std::string getStringValue (ParameterList const &paramList, std::string const &paramName)
template<class IntegralType>
Teuchos::RCP< const Teuchos::StringToIntegralParameterEntryValidator<
IntegralType > > 
getStringToIntegralParameterEntryValidator (ParameterEntry const &entry, ParameterList const &paramList, std::string const &paramName)
 Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object.
std::string demangleName (const std::string &mangledName)
 Demangle a C++ name if valid.
template<typename T>
std::string typeName (const T &t)
 Template function for returning the demangled name of an object.
Teuchos::RCP< const Teuchos::ParameterListgetValidVerboseObjectSublist ()
void setupVerboseObjectSublist (ParameterList *paramList)
void readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
template<class ObjectType>
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
std::string toString (const EVerbosityLevel verbLevel)
 Return a std::string representation of the verbosity level.
bool includesVerbLevel (const EVerbosityLevel verbLevel, const EVerbosityLevel requestedVerbLevel, const bool isDefaultLevel=false)
 Return true if the verbosity level includes the given level.
Teuchos::EVerbosityLevel incrVerbLevel (const EVerbosityLevel inputVerbLevel, const int numLevels)
 Return an increased or decreased verbosity level.
void setVerbosityLevelOption (const std::string &optionName, EVerbosityLevel *verbLevel, const std::string &docString, CommandLineProcessor *clp, const bool required)
std::string Teuchos_Version ()
void set_default_workspace_store (const Teuchos::RCP< WorkspaceStore > &default_workspace_store)
 Set pointer to global workspace object.
Teuchos::RCP< Teuchos::WorkspaceStoreget_default_workspace_store ()
 Get the global workspace object set by set_default_workspace_store().
void print_memory_usage_stats (const WorkspaceStore *workspace_store, std::ostream &out)
 Print statistics on memory usage.
void updateParametersFromXmlFile (const std::string &xmlFileName,Teuchos::ParameterList *paramList)
 Reads XML parameters from a file and updates those already in the given parameter list.
void updateParametersFromXmlString (const std::string &xmlStr,Teuchos::ParameterList *paramList)
 Reads XML parameters from a std::string and updates those already in the given parameter list.
void writeParameterListToXmlOStream (const Teuchos::ParameterList &paramList,std::ostream &xmlOut)
 Write parameters and sublists in XML format to an std::ostream.
void writeParameterListToXmlFile (const Teuchos::ParameterList &paramList,const std::string &xmlFileName)
 Write parameters and sublist to an XML file.

Variables

const char ESideChar [] = {'L' , 'R' }
const char ETranspChar [] = {'N' , 'T' , 'C' }
const char EUploChar [] = {'U' , 'L' }
const char EDiagChar [] = {'U' , 'N' }


Detailed Description

The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.

Enumeration Type Documentation

enum Teuchos::ESide

Enumerator:
LEFT_SIDE  Left side
RIGHT_SIDE  Right side

Definition at line 45 of file Teuchos_BLAS_types.hpp.

enum Teuchos::ETransp

Enumerator:
NO_TRANS  Not transposed
TRANS  Transposed
CONJ_TRANS  Conjugate transposed

Definition at line 50 of file Teuchos_BLAS_types.hpp.

enum Teuchos::EUplo

Enumerator:
UPPER_TRI  Upper triangular
LOWER_TRI  Lower triangular

Definition at line 56 of file Teuchos_BLAS_types.hpp.

enum Teuchos::EDiag

Enumerator:
UNIT_DIAG  Unit diagaonal
NON_UNIT_DIAG  Not unit diagonal

Definition at line 61 of file Teuchos_BLAS_types.hpp.

template<typename Ordinal>
enum EReductionType [related, inherited]

Enumeration for selecting from a set of pre-defined reduction operations.

Enumerator:
REDUCE_SUM  Sum.
REDUCE_MIN  Min.
REDUCE_MAX  Max.
REDUCE_AND  Logical AND.

Definition at line 53 of file Teuchos_CommHelpers.hpp.

enum Teuchos::DataAccess

If set to Copy, user data will be copied at construction. If set to View, user data will be encapsulated and used throughout the life of the object.

Enumerator:
Copy  User data will be copied at construction.
View  User data will be encapsulated and used throughout the life of the object.

Definition at line 47 of file Teuchos_DataAccess.hpp.

enum EValidateUsed [related, inherited]

Definition at line 53 of file Teuchos_ParameterList.hpp.

enum EValidateDefaults [related, inherited]

Definition at line 65 of file Teuchos_ParameterList.hpp.

enum Teuchos::EMetricReduction

Types of reduction operations on performance metrics. Add other operations if you like.

Definition at line 48 of file Teuchos_PerformanceMonitorUtils.hpp.

template<class T>
enum ENull [related, inherited]

Used to initialize a RCP object to NULL using an implicit conversion!

Definition at line 59 of file Teuchos_RCPDecl.hpp.

template<class T>
enum EPrePostDestruction [related, inherited]

Used to specify a pre or post destruction of extra data.

Definition at line 65 of file Teuchos_RCPDecl.hpp.


Function Documentation

void Teuchos::dyn_cast_throw_exception ( const std::string &  T_from,
const std::string &  T_from_concr,
const std::string &  T_to 
)

We throw a m_bad_cast, which is a subclass of bad_cast. This is necessary, since bad_cast lacks the appropriate constructor for use with the TEST_FOR_EXCEPTION macro.

Definition at line 36 of file Teuchos_dyn_cast.cpp.

template<typename Ordinal>
RCP< const MpiReductionOp< Ordinal > > Teuchos::mpiReductionOp ( const RCP< const ValueTypeReductionOp< Ordinal, char > > &  reductOp  ) 

Create an MpiReductionOp object given an ReductionOp object.

Definition at line 179 of file Teuchos_MpiReductionOpSetter.hpp.

RCP<ParameterList> Teuchos::parameterList (  )  [inline]

Nonmember constructor.

Definition at line 567 of file Teuchos_ParameterList.hpp.

RCP<ParameterList> Teuchos::parameterList ( const std::string &  name  )  [inline]

Nonmember constructor.

Definition at line 575 of file Teuchos_ParameterList.hpp.

RCP<ParameterList> Teuchos::parameterList ( const ParameterList &  source  )  [inline]

Nonmember constructor.

Definition at line 582 of file Teuchos_ParameterList.hpp.

template<class IntegralType>
RCP<const StringToIntegralParameterEntryValidator<IntegralType> > Teuchos::getStringToIntegralParameterEntryValidator ( ParameterEntry const &  entry,
ParameterList const &  paramList,
std::string const &  paramName 
)

Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object.

This function with thrown of the validator does not exist.

Definition at line 1111 of file Teuchos_StandardParameterEntryValidators.hpp.

template<class IntegralType>
Teuchos::RCP<const Teuchos::StringToIntegralParameterEntryValidator<IntegralType> > Teuchos::getStringToIntegralParameterEntryValidator ( ParameterEntry const &  entry,
ParameterList const &  paramList,
std::string const &  paramName 
)

Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object.

This function with thrown of the validator does not exist.

Definition at line 1111 of file Teuchos_StandardParameterEntryValidators.hpp.

bool Teuchos::includesVerbLevel ( const EVerbosityLevel  verbLevel,
const EVerbosityLevel  requestedVerbLevel,
const bool  isDefaultLevel = false 
)

Return true if the verbosity level includes the given level.

Parameters:
verbLevel [in] The verbosity level that is in effect.
requestedVerbLevel [in] The verbosity level the client is asking if is included in verbLevel.
isDefaultLevel [in] Set to true if the level in requestedVerbLevel is the default verbosity level. In this case, if verbLevel==VERB_DEFAULT, then this function will return true. The default value is false.

Definition at line 73 of file Teuchos_VerbosityLevel.cpp.

EVerbosityLevel Teuchos::incrVerbLevel ( const EVerbosityLevel  inputVerbLevel,
const int  numLevels 
)

Return an increased or decreased verbosity level.

Parameters:
inputVerbLevel [in] The base verbosity level.
numLevels [in] The number of levels to increase (>0) or decrease (<0).
See the function implementation for details on what it does!

Definition at line 88 of file Teuchos_VerbosityLevel.cpp.

void Teuchos::updateParametersFromXmlFile ( const std::string &  xmlFileName,
Teuchos::ParameterList paramList 
)

Reads XML parameters from a file and updates those already in the given parameter list.

Parameters:
xmlFileName [in] The file name containing XML parameter list specification.
paramList [in/out] On input, *paramList may be empty or contain some parameters and sublists. On output, parameters and sublist from the file xmlFileName will be set or overide those in *paramList.

Definition at line 35 of file Teuchos_XMLParameterListHelpers.cpp.

void Teuchos::updateParametersFromXmlString ( const std::string &  xmlStr,
Teuchos::ParameterList paramList 
)

Reads XML parameters from a std::string and updates those already in the given parameter list.

Parameters:
xmlStr [in] String containing XML parameter list specification.
paramList [in/out] On input, *paramList may be empty or contain some parameters and sublists. On output, parameters and sublist from the file xmlStr will be set or overide those in *paramList.

Definition at line 47 of file Teuchos_XMLParameterListHelpers.cpp.

void Teuchos::writeParameterListToXmlOStream ( const Teuchos::ParameterList paramList,
std::ostream &  xmlOut 
)

Write parameters and sublists in XML format to an std::ostream.

Parameters:
paramList [in] Contains the parameters and sublists that will be written to file.
xmlOut [in] The stream that will get the XML output.

Definition at line 59 of file Teuchos_XMLParameterListHelpers.cpp.

void Teuchos::writeParameterListToXmlFile ( const Teuchos::ParameterList paramList,
const std::string &  xmlFileName 
)

Write parameters and sublist to an XML file.

Parameters:
paramList [in] Contains the parameters and sublists that will be written to file.
xmlFileName [in] The file name that will be create to contain the XML version of the parameter list specification.

Definition at line 69 of file Teuchos_XMLParameterListHelpers.cpp.


Generated on Tue Oct 20 12:45:26 2009 for Teuchos - Trilinos Tools Package by doxygen 1.4.7