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	Teuchos::AbstractFactory< T >
	Simple, universal "Abstract Factory" interface for the dynamic creation of objects. More...
class	Teuchos::PostModNothing< T_impl >
	Default post-modification policy class for AbstractFactorStd which does nothing! More...
class	Teuchos::AllocatorNew< T_impl >
	Default allocation policy class for AbstractFactoryStd which returns new T_impl(). More...
class	Teuchos::AbstractFactoryStd< T_itfc, T_impl, T_PostMod, T_Allocator >
	Simple, templated concrete subclass of universal "Abstract Factory" interface for the creation of objects. More...
class	Teuchos::any
	Modified boost::any class, which is a container for a templated value. More...
class	Teuchos::bad_any_cast
	Thrown if any_cast is attempted between two incompatable types. More...
class	Teuchos::InvalidArrayStringRepresentation
	More...
class	Teuchos::ArrayArg< N, T >
	Utility class that allows arrays to be passed into argument list. More...
class	Teuchos::ArrayRCP< T >
	Array reference-counted pointer class. More...
class	Teuchos::NullIteratorTraits< ArrayRCP< T > >
	Traits specialization for ArrayRCP. More...
class	Teuchos::ValueTypeConversionTraits< TypeTo, TypeFrom >
	Default traits class for all conversions of value types. More...
class	Teuchos::basic_oblackholestream< _CharT, _Traits >
	basic_ostream<> subclass that does nothing but discard output. More...
class	Teuchos::BLAS< OrdinalType, ScalarType >
	The Templated BLAS Wrapper Class. More...
class	Teuchos::CommRequest
	More...
class	Teuchos::Comm< Ordinal >
	Abstract interface class for a basic communication channel between one or more processes. More...
class	Teuchos::CommandLineProcessor
	Class that helps parse command line input arguments from (argc,argv[]) and set options. More...
class	Teuchos::CommandLineProcessor::ParseError
	Thrown if a parse std::exception occurs and throwExceptions==true. More...
class	Teuchos::CommandLineProcessor::HelpPrinted
	Thrown if --help was specified and throwExceptions==true. More...
class	Teuchos::CommandLineProcessor::UnrecognizedOption
	Thrown if an unrecognized option was found and throwExceptions==true. More...
class	Teuchos::SumValueReductionOp< Ordinal, Packet >
	Standard summation operator for types with value semantics. More...
class	Teuchos::MinValueReductionOp< Ordinal, Packet >
	Standard min operator for types with value semantics. More...
class	Teuchos::MaxValueReductionOp< Ordinal, Packet >
	Standard Max operator for types with value semantics. More...
class	Teuchos::ANDValueReductionOp< Ordinal, Packet >
	Standard logical AND operator for booleans. More...
class	Teuchos::CompileTimeAssert< Test >
	If instantiated (for Test!=0) then this should not compile! More...
class	Teuchos::CompileTimeAssert< 0 >
	If instantiated (i.e. Test==0) then this will compile! More...
class	Teuchos::CompObject
	Functionality and data that is common to all computational classes. More...
class	Teuchos::ConstNonconstObjectContainer< ObjType >
	Simple class for containing an object and protecting const with a runtime check which throws an std::exception. More...
class	Teuchos::ConstTypeTraits< T >
	Traits class that strips of 'const'. More...
class	Teuchos::DefaultComm< Ordinal >
	Returns a default global communicator appropriate for the enviroment. More...
class	Teuchos::MpiCommRequest
	More...
class	Teuchos::MpiComm< Ordinal >
	Concrete communicator subclass based on MPI. More...
class	Teuchos::SerialComm< Ordinal >
	Concrete serial communicator subclass. More...
class	Teuchos::Describable
	Base class for all objects that can describe themselves and their current state. More...
class	Teuchos::m_bad_cast
	Exception class for bad cast. More...
class	Teuchos::ErrorPolling
	ErrorPolling provides utilities for establishing agreement between processors on whether an std::exception has been detected on any one processor. More...
class	Teuchos::ExceptionBase
	Base exception class for Teuchos. More...
class	Teuchos::NullReferenceError
	Null reference error exception class. More...
class	Teuchos::RangeError
	Range error exception class. More...
class	Teuchos::DanglingReferenceError
	Dangling reference error exception class. More...
class	Teuchos::IncompatibleIteratorsError
	Incompatiable iterators error exception class. More...
class	Teuchos::basic_FancyOStream_buf< CharT, Traits >
	Stream buffering class that performs the magic of indenting data sent to an std::ostream object. More...
class	Teuchos::basic_FancyOStream< CharT, Traits >
	std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among other things. More...
class	Teuchos::basic_OSTab< CharT, Traits >
	Tabbing class for helping to create formated, indented output for a basic_FancyOStream object. More...
class	Teuchos::FileInputSource
	Instantiation of XMLInputSource class for reading XML from a file. More...
class	Teuchos::FileInputStream
	Instantiation of XMLInputStream class for reading an entire document from a file. More...
class	Teuchos::Flops
	The Teuchos Floating Point Operations Class. More...
class	Teuchos::GlobalMPISession
	This class provides methods for initializing, finalizing, and querying the global MPI session. More...
class	Teuchos::ConstHandle< PointerType >
	Templated handle class with strong const protection. More...
class	Teuchos::Handle< PointerType >
	Generic templated handle class. More...
class	Teuchos::ConstHandleable< Base >
	Class ConstHandleable provides an abstract interface for polymorphic conversion from raw pointers to const smart pointers. More...
class	Teuchos::Handleable< Base >
	Class Handleable provides an abstract interface for polymorphic conversion from raw pointers to smart pointers. More...
class	Teuchos::HashSet< Key >
	Templated hashtable-based set. More...
class	Teuchos::HashPair< Key, Value >
	Helper class for Teuchos::Hashtable, representing a single <key, value> pair. More...
class	Teuchos::Hashtable< Key, Value >
	Templated hashtable class. More...
class	Teuchos::HashUtils
	Utilities for generating hashcodes. More...
class	Teuchos::LabeledObject
	Base class for objects that contain a std::string label. More...
class	Teuchos::LAPACK< OrdinalType, ScalarType >
	The Templated LAPACK Wrapper Class. More...
class	Teuchos::MPIComm
	Object representation of an MPI communicator. More...
class	Teuchos::MPIContainerComm< T >
	Object representation of an MPI communicator for templated containers. More...
class	Teuchos::MpiReductionOpBase
	Base class for an MPI-compatible reduction operator. More...
class	Teuchos::MpiReductionOp< Ordinal >
	Standard subclass implementation for MpiReductionOpBase in terms of a templated ReductionOp<Ordinal,char> object. More...
class	Teuchos::MpiReductionOpSetter
	Utility class for setting an MPI-compatible reduction object and using it to create an MPI_Op object. More...
class	Teuchos::MPISession
	This class provides methods for initializing, finalizing, and querying the global MPI session. More...
class	Teuchos::MPITraits< T >
	Templated traits class that binds MPI types to C++ types. More...
class	Teuchos::NullIteratorTraits< Iter >
	Base traits class for getting a properly initialized null pointer. More...
class	Teuchos::NullIteratorTraits< std::reverse_iterator< Iter > >
	Partial specialization for std::reverse_iterator. More...
class	Teuchos::Object
	The base Teuchos class. More...
class	Teuchos::OpaqueWrapper< Opaque >
	Base class for wrapped opaque objects. More...
class	Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree >
	Subclass for wrapped opaque objects with a free function. More...
struct	Teuchos::OrdinalTraits< T >
	This structure defines some basic traits for the ordinal field type. More...
class	Teuchos::ParameterEntry
	This object is held as the "value" in the Teuchos::ParameterList std::map. More...
class	Teuchos::ParameterEntryValidator
	Abstract interface for an object that can validate a ParameterEntry's value. More...
class	Teuchos::ParameterList
	Templated parameter list. More...
class	Teuchos::ParameterList::PrintOptions
	Utility class for setting and passing in print options. More...
class	Teuchos::TypeNameTraits< ParameterList >
	Traits specialization. More...
class	Teuchos::ParameterListAcceptor
	Base class objects that can accept a parameter list. More...
class	Teuchos::ParameterListAcceptorDefaultBase
	Intermediate node base class for objects that accept parameter lists that implements some of the needed behavior automatically. More...
class	Teuchos::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	Teuchos::ParameterXMLFileReader
class	Teuchos::PerformanceMonitorBase< T >
	Provides common capabilities for collecting and reporting performance data across processors. More...
class	Teuchos::PerformanceMonitorUtils
	Provides common capabilities for collecting and reporting performance data across processors. More...
class	Teuchos::Polynomial< CoeffT >
	Lightweight container class to represent a simple polynomial. More...
class	Teuchos::PolynomialTraits< Scalar >
	Traits class for polynomial coefficients in Teuchos::Polynomial. More...
class	Teuchos::Ptr< T >
	Simple wrapper class for raw pointers to single objects where no persisting relationship exists. More...
class	Teuchos::Range1D
	Subregion Index Range Class. More...
class	Teuchos::RawMPITraits< T >
	Templated traits class that allows a datatype to be used with MPI that MPI can directly handle. More...
class	Teuchos::DeallocBoostSharedPtr< T >
	Teuchos::RCP Deallocator class that wraps a boost::shared_ptr More...
class	Teuchos::RCPDeleter< T >
	boost::shared_ptr deleter class that wraps a Teuchos::RCP. More...
class	Teuchos::RCP< T >
	Smart reference counting pointer class for automatic garbage collection. More...
class	Teuchos::NullIteratorTraits< RCP< T > >
	Traits specialization for RCP. More...
class	Teuchos::DeallocDelete< T >
	Policy class for deallocator that uses delete to delete a pointer which is used by RCP. More...
class	Teuchos::DeallocArrayDelete< T >
	Deallocator class that uses delete [] to delete memory allocated uisng new []. More...
class	Teuchos::DeallocFunctorDelete< T, DeleteFunctor >
	Deallocator subclass that Allows any functor object (including a function pointer) to be used to free an object. More...
class	Teuchos::DeallocFunctorHandleDelete< T, DeleteHandleFunctor >
	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	Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >
	A deallocator class that wraps a simple value object and delegates to another deallocator object. More...
class	Teuchos::RCPNode
	Node class to keep track of address and the reference count for a reference-counted utility class and delete the object. More...
class	Teuchos::RCPNodeTmpl< T, Dealloc_T >
	Implementation class for actually deleting the object. More...
class	Teuchos::PrintActiveRCPNodes
	Print global list on destruction. More...
class	Teuchos::RCPNodeHandle
	Utility handle class for handling the reference counting and managuement of the RCPNode object. More...
class	Teuchos::ValueTypeReductionOp< Ordinal, T >
	Base interface class for user-defined reduction operations for objects that use value semantics. More...
class	Teuchos::ReferenceTypeReductionOp< Ordinal, T >
	Base interface class for user-defined reduction operations for objects that use reference semantics. More...
class	Teuchos::CharToValueTypeReductionOp< Ordinal, T >
	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	Teuchos::CharToReferenceTypeReductionOp< Ordinal, T >
	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	Teuchos::ScalarTraits< T >
	This structure defines some basic traits for a scalar field type. More...
class	Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >
	This class creates and provides basic support for dense rectangular matrix of templated type. More...
class	Teuchos::SerialDenseSolver< OrdinalType, ScalarType >
	A class for solving dense linear problems. More...
class	Teuchos::SerialDenseVector< OrdinalType, ScalarType >
	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...
class	Teuchos::SerializationTraits< Ordinal, T >
	Serialization traits class for types that use value semantics. More...
class	Teuchos::ValueTypeSerializationBuffer< Ordinal, T >
	Encapsulate how an array of non-const objects with value sematics is serialized into a char[] array. More...
class	Teuchos::ConstValueTypeSerializationBuffer< Ordinal, T >
	Encapsulate how an array of const objects with value sematics is serialized into a const char[] array. More...
class	Teuchos::ValueTypeDeserializationBuffer< Ordinal, T >
	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	Teuchos::ConstValueTypeDeserializationBuffer< Ordinal, T >
	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	Teuchos::Serializer< Ordinal, T >
	Strategy interface for the indirect serializing and deserializing objects of a given type handled using reference semantics. More...
class	Teuchos::ReferenceTypeSerializationBuffer< Ordinal, T >
	Encapsulate how an array of non-const objects with reference sematics is serialized into a char[] array and deserialized again. More...
class	Teuchos::ConstReferenceTypeSerializationBuffer< Ordinal, T >
	Encapsulate how an array of const objects with reference sematics is serialized into a char[] array. More...
class	Teuchos::ReferenceTypeDeserializationBuffer< Ordinal, T >
	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	Teuchos::ConstReferenceTypeDeserializationBuffer< Ordinal, T >
	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	Teuchos::SerialSpdDenseSolver< OrdinalType, ScalarType >
	A class for constructing and using Hermitian positive definite dense matrices. More...
class	Teuchos::SerialSymDenseMatrix< OrdinalType, ScalarType >
	This class creates and provides basic support for symmetric, positive-definite dense matrices of templated type. More...
class	Teuchos::StringToIntegralParameterEntryValidator< IntegralType >
	Standard implementation of a ParameterEntryValidator that maps from a list of strings to some integral type value. More...
class	Teuchos::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	Teuchos::AnyNumberParameterEntryValidator::AcceptedTypes
	Determines the types that are accepted. More...
class	Teuchos::StringInputSource
	Instantiation of XMLInputSource class for reading XML from a std::string. More...
class	Teuchos::StringInputStream
	Instantiation of XMLInputStream for reading an entire document from a std::string. More...
class	Teuchos::StringToIntMap
	Map a std::string to an enumeration. More...
class	Teuchos::StringToIntMap::AlreadyExists
	More...
class	Teuchos::StringToIntMap::DoesNotExist
	More...
class	Teuchos::StrUtils
	Provides std::string manipulation utilities that are not provided in the standard C++ std::string class. More...
class	Teuchos::TableColumn
class	Teuchos::TableEntry
	An entry, perhaps compound, to be written into a table. More...
class	Teuchos::DoubleEntry
	A table entry that is a simple double-precision number. More...
class	Teuchos::IntEntry
	A table entry that is a simple integer. More...
class	Teuchos::StringEntry
	A table entry that is a simple std::string. More...
class	Teuchos::CompoundEntryWithParentheses
	An entry containing two subentries, with the second to be written in parentheses after the first. For example, 1.23(456) The two subentries can be any type of data, each represented with a TableEntry derived type. More...
class	Teuchos::TableFormat
	Encapsulation of formatting specifications for writing data in a clean tabular form. More...
class	Teuchos::TabularOutputter
	Utility class that makes it easy to create formatted tables of output. More...
class	Teuchos::TabularOutputter::MissingFieldsError
	More...
class	Teuchos::TabularOutputter::InvalidFieldSpecError
	More...
class	Teuchos::TabularOutputter::MissingHeaderError
	More...
class	Teuchos::TabularOutputter::InvalidFieldOutputError
	More...
class	Teuchos::RelErrSmallNumber< hasMachineParameters, Scalar >
	More...
class	Teuchos::RelErrSmallNumber< false, Scalar >
	More...
class	Teuchos::RelErrSmallNumber< true, Scalar >
	More...
class	Teuchos::Time
	Basic wall-clock timer class. More...
class	Teuchos::TimeMonitor
	A timer class that starts when constructed and stops when the destructor is called. More...
class	Teuchos::ToStringTraits< T >
	Default traits class for converting objects into strings. More...
class	Teuchos::ToStringTraits< bool >
	Specialization for bool. More...
class	Teuchos::ToStringTraits< std::string >
	Specialization for std::string. More...
class	Teuchos::TreeBuildingXMLHandler
	TreeBuildingXMLHandler assembles a XMLObject from your XML input. More...
class	Teuchos::TypeNameTraits< T >
	Default traits class that just returns typeid(T).name(). More...
class	Teuchos::UnitTestBase
	Unit test base class. More...
class	Teuchos::UnitTestRepository
	Singleton unit testing repository. More...
class	Teuchos::Utils
	This class provides some basic std::string and floating-point utilities for Teuchos. More...
class	Teuchos::VerboseObjectBase
	Non-templated base class for objects that can print their activities to a stream. More...
class	Teuchos::VerboseObject< ObjectType >
	Templated base class for objects that can print their activities to a stream and have a verbosity level. More...
class	Teuchos::VerboseObjectTempState< ObjectType >
	Set and release a stream and verbosity level. More...
class	Teuchos::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	Teuchos::Workspace< T >
	Templated class for workspace creation. More...
class	Teuchos::WorkspaceStore
	Workspace encapsulation class. More...
class	Teuchos::WorkspaceStoreInitializeable
	WorkspaceStore class that can be used to actually reinitialize memory. More...
class	Teuchos::XMLInputSource
	XMLInputSource represents a source of XML input that can be parsed to produce an XMLObject. More...
class	Teuchos::XMLInputStream
	XMLInputStream represents an XML input stream that can be used by a XMLInputSource. More...
class	Teuchos::EmptyXMLError
	Thrown when attempting to parse an empty XML std::string. More...
class	Teuchos::XMLObject
	Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object, allowing storage by reference. More...
class	Teuchos::XMLObjectImplem
	The XMLObjectImplem class takes care of the low-level implementation details of XMLObject. More...
class	Teuchos::XMLParameterListReader
	Writes an XML object to a parameter list. More...
class	Teuchos::XMLParameterListWriter
	Writes a ParameterList to an XML object. More...
class	Teuchos::XMLParser
	XMLParser consumes characters from an XMLInputStream object, parsing the XML and using a TreeBuildingXMLHandler to construct an XMLObject. More...
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	ENull
	Used to initialize a RCP object to NULL using an implicit conversion! More...
enum	EValidateUsed
	ParameterList More...
enum	EValidateDefaults
	ParameterList More...
enum	EMetricReduction
	Types of reduction operations on performance metrics. Add other operations if you like. More...
enum	EPrePostDestruction
	Used to specify a pre or post destruction of extra data. More...
enum	ERCPStrength
	Used to specify if the pointer is weak or strong. 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>
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 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.
void	dyn_cast_throw_exception (const std::string &type_from_name, const std::string &type_from_concr_name, const std::string &type_to_name)
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 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.
RCP< ParameterList >	parameterList ()
	Nonmember constructor.
RCP< ParameterList >	parameterList (const std::string &name)
	Nonmember constructor.
RCP< ParameterList >	parameterList (const ParameterList &source)
	Nonmember constructor.
template<class T>
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.
int	numActiveRCPNodes ()
	Print the number of active RCPNode objects being tracked.
void	throw_null_ptr_error (const std::string &type_name)
	Throw that a pointer passed into an RCP object is null.
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 EnumType>
EnumType	get (StringToIntMap const &theMap, std::string const &option, std::string const &groupName="")
	Nonmember get function. StringToIntMap.
const std::string	passfail (const bool result)
	Return "passed" for "failed".
template<class Scalar>
Scalar	defaultSmallNumber ()
template<class Scalar>
ScalarTraits< Scalar >::magnitudeType	relErr (const Scalar &s1, const Scalar &s2)
	Return relative error of two scalars.
template<class Scalar>
bool	testRelErr (const std::string &v1_name, const Scalar &v1, const std::string &v2_name, const Scalar &v2, const std::string &maxRelErr_error_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &maxRelErr_error, const std::string &maxRelErr_warning_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &maxRelErr_warning, const Ptr< std::ostream > &out)
	Compute, check and optionally print the relative error in two scalars.
template<class Array1, class Array2>
bool	compareArrays (const Array1 &a1, const std::string &a1_name, const Array2 &a2, const std::string &a2_name, Teuchos::FancyOStream &out)
	Compare if two array objects are the same or not.
template<class Array1, class Array2, class ScalarMag>
bool	compareFloatingArrays (const Array1 &a1, const std::string &a1_name, const Array2 &a2, const std::string &a2_name, const ScalarMag &tol, Teuchos::FancyOStream &out)
	Compare if two array objects are the same or not up to a relative floating point precision.
template<typename T>
std::string	toString (const T &t)
	Utility function for returning a pretty string representation of a object of type T.
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.
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.
EVerbosityLevel	incrVerbLevel (const EVerbosityLevel inputVerbLevel, const int numLevels)
	Return an increased or decreased verbosity level.
void	set_default_workspace_store (const Teuchos::RCP< WorkspaceStore > &default_workspace_store)
	Set pointer to global workspace object.
Teuchos::RCP< WorkspaceStore >	get_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.
RCP< ParameterList >	getParametersFromXmlFile (const std::string &xmlFileName)
	Reads XML parameters from a file and return them in a new 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.
RCP< ParameterList >	getParametersFromXmlString (const std::string &xmlStr)
	Reads XML parameters from a std::string and return them in a new 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.

---

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 ESide

Enumeration values: LEFT_SIDE  Left side RIGHT_SIDE  Right side

enum ETransp

Enumeration values: NO_TRANS  Not transposed TRANS  Transposed CONJ_TRANS  Conjugate transposed

enum EUplo

Enumeration values: UPPER_TRI  Upper triangular LOWER_TRI  Lower triangular

enum EDiag

Enumeration values: UNIT_DIAG  Unit diagaonal NON_UNIT_DIAG  Not unit diagonal

enum EReductionType

Enumeration for selecting from a set of pre-defined reduction operations. Enumeration values: REDUCE_SUM  Sum. REDUCE_MIN  Min. REDUCE_MAX  Max. REDUCE_AND  Logical AND.

enum 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. Enumeration values: Copy  User data will be copied at construction. View  User data will be encapsulated and used throughout the life of the object.

enum ENull

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

enum EValidateUsed

ParameterList

enum EValidateDefaults

ParameterList

enum EMetricReduction

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

---

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.

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

Create an MpiReductionOp object given an ReductionOp object.

RCP<ParameterList> parameterList (   )  [inline]

Nonmember constructor.

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

Nonmember constructor.

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

Nonmember constructor.

int Teuchos::numActiveRCPNodes (   )

Print the number of active RCPNode objects being tracked.

void Teuchos::throw_null_ptr_error (  const std::string &