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

Namespaces

namespace  Utilities
namespace  MixMaxUtilities
namespace  Exceptions
namespace  PtrPrivateUtilityPack
namespace  TypeTraits

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
 Memory-safe tempalted array class that encapsulates std::vector. More...
class  ArrayArg
 Utility class that allows arrays to be passed into argument list. More...
class  ArcpReinterpretCastEmbeddedObj
class  ArrayRCP
 Array reference-counted pointer class. More...
class  NullIteratorTraits< ArrayRCP< T > >
 Traits specialization for ArrayRCP. More...
class  ArrayView
 Array view class. 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  DefaultBLASImpl
 Default implementation for BLAS routines. More...
class  BLAS
 The Templated BLAS Wrapper Class. More...
class  BLAS< int, float >
class  BLAS< int, double >
class  BLAS< int, std::complex< float > >
class  BLAS< int, std::complex< double > >
class  CommRequest
  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 supporting the "runtime protection of const" idiom. More...
class  ConstTypeTraits
 Traits class that strips 'const' off of a type. More...
class  DefaultComm
 Returns a default global communicator appropriate for the enviroment. More...
class  MpiCommRequest
  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  ExceptionBase
 Base exception class for Teuchos. More...
class  DuplicateOwningRCPError
 Thrown if a duplicate owning RCP is creatd the the same object. More...
class  NullReferenceError
 Null reference error exception class. More...
class  NonconstAccessError
 Null reference error exception class. More...
class  RangeError
 Range error exception class. More...
class  DanglingReferenceError
 Dangling reference error exception class. More...
class  IncompatibleIteratorsError
 Incompatiable iterators error exception class. 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  RawPointerConversionTraits
class  RawPointerConversionTraits< RawType * >
class  RawPointerConversionTraits< ArrayRCP< T > >
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  NullIteratorTraits
 Base traits class for getting a properly initialized null pointer. More...
class  NullIteratorTraits< std::reverse_iterator< Iter > >
 Partial specialization for std::reverse_iterator. More...
class  Object
 The base Teuchos class. More...
class  ObjectBuilder
 Generic parameterlist driven bulider 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  PromotionTraits
class  PromotionTraits< T, T >
class  Ptr
 Simple wrapper class for raw pointers to single objects where no persisting relationship exists. More...
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  NullIteratorTraits< RCP< T > >
 Traits specialization for RCP. More...
class  DeallocNull
 Policy class for deallocator for non-owned RCPs. 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  EmbeddedObjDealloc
 A deallocator class that wraps a simple value object and delegates to another deallocator object. More...
class  ToStringTraits< ERCPStrength >
 Traits class specialization for toString(...) function for converting from ERCPStrength to std::string. More...
class  RCPNode
 Node class to keep track of address and the reference count for a reference-counted utility class and delete the object. More...
class  RCPNodeTracer
 Debug-mode RCPNode tracing class. More...
class  RCPNodeTmpl
 Templated implementation class of RCPNode that has the responsibility for deleting the reference-counted object. More...
class  ActiveRCPNodesSetup
 Sets up node tracing and prints remaining RCPNodes on destruction. More...
class  RCPNodeHandle
 Utility handle class for handling the reference counting and managuement of the RCPNode object. More...
class  RCPNodeThrowDeleter
 Deletes a (non-owning) RCPNode but not it's underlying object in case of a throw. 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  ScalarTraits< int >
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  SerialDenseSolver
 A class for solving dense linear problems. 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, short int >
class  SerializationTraits< Ordinal, int >
class  SerializationTraits< Ordinal, unsigned int >
class  SerializationTraits< Ordinal, long int >
class  SerializationTraits< Ordinal, long unsigned int >
class  SerializationTraits< Ordinal, float >
class  SerializationTraits< Ordinal, double >
class  SerializationTraits< Ordinal, std::pair< P1, P2 > >
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  SerialSpdDenseSolver
 A class for constructing and using Hermitian positive definite dense matrices. More...
class  SerialSymDenseMatrix
 This class creates and provides basic support for symmetric, positive-definite dense matrices of templated type. More...
class  SimpleObjectTable
 This class provides a central place to store objects. 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  TabularOutputter
 Utility class that makes it easy to create formatted tables of output. More...
class  RelErrSmallNumber
  More...
class  RelErrSmallNumber< false, Scalar >
  More...
class  RelErrSmallNumber< true, Scalar >
  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  ToStringTraits
 Default traits class for converting objects into strings. More...
class  ToStringTraits< bool >
 Specialization for bool. More...
class  ToStringTraits< std::string >
 Specialization for std::string. More...
class  TreeBuildingXMLHandler
 TreeBuildingXMLHandler assembles a XMLObject from your XML input. More...
class  Tuple
 Statically sized simple array (tuple) class. More...
class  TypeNameTraits
 Default traits class that just returns typeid(T).name(). More...
class  TypeNameTraits< T * >
class  TypeNameTraits< std::string >
class  TypeNameTraits< void * >
class  UnitTestBase
 Unit test base class. More...
struct  UnitTestData
class  UnitTestRepository
 Singleton unit testing repository. More...
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...
struct  ScalarTraits< std::pair< Packet, Packet > >
class  ValueTypeConversionTraits< std::pair< Packet, Packet >, ConvertToPacket >
class  MockRCP
class  TypeNameTraits< UndefinedType2 >
class  TypeNameTraits< Opaque3_handle >
class  Foo
class  FooA
class  FooB
class  FooC

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 { null }
 

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

More...
enum  EValidateUsed { VALIDATE_USED_ENABLED, VALIDATE_USED_DISABLED }
  More...
enum  EValidateDefaults { VALIDATE_DEFAULTS_ENABLED, VALIDATE_DEFAULTS_DISABLED }
  More...
enum  EMetricReduction {
  ELocal, ETotal, EMin, EMax,
  EAvg
}
 

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

More...
enum  ERCPWeakNoDealloc { RCP_WEAK_NO_DEALLOC }
enum  ERCPUndefinedWeakNoDealloc { RCP_UNDEFINED_WEAK_NO_DEALLOC }
enum  ERCPUndefinedWithDealloc { RCP_UNDEFINED_WITH_DEALLOC }
enum  EPrePostDestruction { PRE_DESTROY, POST_DESTROY }
 

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

More...
enum  ERCPStrength { RCP_STRENGTH_INVALID = -1, RCP_STRONG = 0, RCP_WEAK = 1 }
 

Used to specify if the pointer is weak or strong.

More...
enum  ERCPNodeLookup { RCP_ENABLE_NODE_LOOKUP, RCP_DISABLE_NODE_LOOKUP }
 

Used to determine if RCPNode lookup is performed or not.

More...
enum  EShowTestDetails { SHOW_TEST_DETAILS_ALL, SHOW_TEST_DETAILS_TEST_NAMES, SHOW_TEST_DETAILS_FINAL_RESULTS }
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 >
TEUCHOS_DEPRECATED ArrayArg< 1, T > arrayArg (T t1)
 Return an array with 1 member.
template<class T >
TEUCHOS_DEPRECATED ArrayArg< 2, T > arrayArg (T t1, T t2)
 Return an array with 2 members.
template<class T >
TEUCHOS_DEPRECATED ArrayArg< 3, T > arrayArg (T t1, T t2, T t3)
 Return an array with 3 members.
template<class T >
TEUCHOS_DEPRECATED ArrayArg< 4, T > arrayArg (T t1, T t2, T t3, T t4)
 Return an array with 4 members.
template<class T >
TEUCHOS_DEPRECATED ArrayArg< 5, T > arrayArg (T t1, T t2, T t3, T t4, T t5)
 Return an array with 5 members.
template<class T >
TEUCHOS_DEPRECATED ArrayArg< 6, T > arrayArg (T t1, T t2, T t3, T t4, T t5, T t6)
 Return an array with 6 members.
template<class ArrayPtrT_in , class T_out >
void arrayViewPtrConv (const ArrayPtrT_in &a_in, const ArrayView< Ptr< T_out > > &a_out)
 Utility function to convert from an an input Array[View,RCP]<[const] PTR<T_in> > object to an output ArrayView<Ptr<T_out> > object.
template<class ArrayPtrT_in , class T_out >
void arrayViewRcpConv (const ArrayPtrT_in &a_in, const ArrayView< RCP< T_out > > &a_out)
 Utility function to convert from an input Array[View,RCP]<[const] RCP<T_in> > object to an output ArrayView<RCP<T_out> > object.
template<class T_out , class ArrayPtrT_in >
Array< Ptr< T_out > > arrayPtrConv (const ArrayPtrT_in &a_in)
 Utility function to convert an Array[View,RCP]<[const] PTR<T_in> > object to an Array<Ptr<T_out> > object.
template<class T_out , class ArrayPtrT_in >
Array< RCP< T_out > > arrayRcpConv (const ArrayPtrT_in &a_in)
 Utility function to convert any Array[View,RCP]<[const] RCP<T_in> > object to an Array<RCP<T_out> > object.
template<class T >
ArrayView< const Ptr< const T > > arrayConstPtrConstCast (const ArrayView< const Ptr< T > > &a_in)
 Utility function that does a reinterpret case to convert an ArrayView<const Ptr<T> > object to an ArrayView<const Ptr<const T> > object.
template<class T >
ArrayView< const RCP< const T > > arrayConstRcpConstCast (const ArrayView< const RCP< T > > &a_in)
 Utility function that does a reinterpret case to convert an ArrayView<const RCP<T> > object to an ArrayView<const RCP<const T> > object.
template<class T >
RCPNodeArrayRCP_createNewRCPNodeRawPtr (T *p, bool has_ownership_in)
template<class T , class Dealloc_T >
RCPNodeArrayRCP_createNewDeallocRCPNodeRawPtr (T *p, Dealloc_T dealloc, bool has_ownership_in)
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 >
TEUCHOS_DEPRECATED void reduceAll (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *globalReduct)
 Deprecated .
template<typename Ordinal , typename Packet >
TEUCHOS_DEPRECATED void scan (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *scanReduct)
 Deprecated.
template<typename Ordinal , typename Packet >
ValueTypeReductionOp< Ordinal,
Packet > * 
createOp (const EReductionType reductType)
TEUCHOS_LIB_DLL_EXPORT 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 Container >
RawPointerConversionTraits
< Container >::Ptr_t 
getRawPtr (const Container &c)
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.
template<class ObjectType >
RCP< ObjectBuilder< ObjectType > > objectBuilder ()
template<class ObjectType >
RCP< ObjectBuilder< ObjectType > > objectBuilder (const std::string &objectName, const std::string &objectTypeName)
RCP< ParameterListparameterList ()
 Nonmember constructor.
RCP< ParameterListparameterList (const std::string &name)
 Nonmember constructor.
RCP< ParameterListparameterList (const ParameterList &source)
 Nonmember constructor.
TEUCHOS_LIB_DLL_EXPORT void printValidParameters (const ParameterListAcceptor &paramListAccpetor, std::ostream &out, const bool showDoc=true)
 Pretty print the valid parameters from a ParameterListAccpetor object.
template<class T >
RCPNodeRCP_createNewRCPNodeRawPtrNonowned (T *p)
template<class T >
RCPNodeRCP_createNewRCPNodeRawPtrNonownedUndefined (T *p)
template<class T >
RCPNodeRCP_createNewRCPNodeRawPtr (T *p, bool has_ownership_in)
template<class T , class Dealloc_T >
RCPNodeRCP_createNewDeallocRCPNodeRawPtr (T *p, Dealloc_T dealloc, bool has_ownership_in)
template<class T , class Dealloc_T >
RCPNodeRCP_createNewDeallocRCPNodeRawPtrUndefined (T *p, Dealloc_T dealloc, bool has_ownership_in)
template<class T , class Dealloc_T >
RCP< T > rcp (T *p, Dealloc_T dealloc, bool owns_mem)
 Deprecated.
template<class T , class Embedded >
RCP< T > rcpWithEmbeddedObjPreDestroy (T *p, const Embedded &embedded, bool owns_mem=true)
template<class T , class Embedded >
RCP< T > rcpWithEmbeddedObjPostDestroy (T *p, const Embedded &embedded, bool owns_mem=true)
template<class T , class Embedded >
RCP< T > rcpWithEmbeddedObj (T *p, const Embedded &embedded, bool owns_mem=true)
template<class T , class ParentT >
RCP< T > rcpWithInvertedObjOwnership (const RCP< T > &child, const RCP< ParentT > &parent)
 Create a new RCP that inverts the ownership of parent and child.
template<class ParentT , class T >
RCP< ParentT > getInvertedObjOwnershipParent (const RCP< T > &invertedChild)
 Get the parent back from an inverted ownership RCP.
void debugAssertStrength (ERCPStrength strength)
 
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.
void updateSuccess (const bool result, bool &success)
 Update the success bool flag.
const std::string passfail (const bool result)
 Return "passed" or "failed".
TEUCHOS_LIB_DLL_EXPORT const
std::string 
passfail_with_location (const bool result, const std::string &file, const int lineNumber)
 Helper function for TEUCHOS_PASS_FAIL(...).
void showTestFailureLocation (bool)
 Set if TEUCHOS_PASS_FAIL(...) should print test failure location.
bool showTestFailureLocation ()
 Return if TEUCHOS_PASS_FAIL(...) should print test failure location.
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.
TEUCHOS_LIB_DLL_EXPORT 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 concrete type name of a passed-in object.
template<typename T >
std::string concreteTypeName (const T &t)
 Template function for returning the type name of the actual concrete name of a passed-in object.
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (bool)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (char)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (int)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (short int)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (long int)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (float)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (double)
bool operator< (const UnitTestData &a, const UnitTestData &b)
std::string getUnitTestName (const std::string groupName, const std::string testName)
bool strMatch (const std::string &fullMatchStr, const std::string &str)
TEUCHOS_LIB_DLL_EXPORT std::string toString (const EVerbosityLevel verbLevel)
 Return a std::string representation of the verbosity level.
TEUCHOS_LIB_DLL_EXPORT bool includesVerbLevel (const EVerbosityLevel verbLevel, const EVerbosityLevel requestedVerbLevel, const bool isDefaultLevel=false)
 Return true if the verbosity level includes the given level.
TEUCHOS_LIB_DLL_EXPORT
EVerbosityLevel 
incrVerbLevel (const EVerbosityLevel inputVerbLevel, const int numLevels)
 Return an increased or decreased verbosity level.
std::string Teuchos_Version ()
TEUCHOS_LIB_DLL_EXPORT void set_default_workspace_store (const Teuchos::RCP< WorkspaceStore > &default_workspace_store)
 Set pointer to global workspace object.
TEUCHOS_LIB_DLL_EXPORT
Teuchos::RCP< WorkspaceStore
get_default_workspace_store ()
 Get the global workspace object set by set_default_workspace_store().
TEUCHOS_LIB_DLL_EXPORT void print_memory_usage_stats (const WorkspaceStore *workspace_store, std::ostream &out)
 Print statistics on memory usage.
TEUCHOS_LIB_DLL_EXPORT 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< ParameterListgetParametersFromXmlFile (const std::string &xmlFileName)
 Reads XML parameters from a file and return them in a new parameter list.
TEUCHOS_LIB_DLL_EXPORT 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< ParameterListgetParametersFromXmlString (const std::string &xmlStr)
 Reads XML parameters from a std::string and return them in a new parameter list.
TEUCHOS_LIB_DLL_EXPORT void writeParameterListToXmlOStream (const Teuchos::ParameterList &paramList, std::ostream &xmlOut)
 Write parameters and sublists in XML format to an std::ostream.
TEUCHOS_LIB_DLL_EXPORT void writeParameterListToXmlFile (const Teuchos::ParameterList &paramList, const std::string &xmlFileName)
 Write parameters and sublist to an XML file.
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, create)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, DefaultConstruct)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, NonconstConstruct)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, ConstConstruct)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, NonconstInitialize)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, ConstInitialize)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, AssignmentFromRCP)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, uninitialize)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, parens)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, arrow)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, arrowEmpty)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, dereference)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, dereferenceEmpty)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, castToRCP)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, castFromRCP)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, is_null)
 TEUCHOS_UNIT_TEST (ConstNonconstObjectContainer, nonnull)
 TEUCHOS_UNIT_TEST (GetBaseObjVoidPtr, polymorphicClasses)
 TEUCHOS_UNIT_TEST (GetBaseObjVoidPtr, nonPolymorphicClasses)
 TEUCHOS_UNIT_TEST (GetBaseObjVoidPtr, nonPolymorphicBuiltInTypes)
 TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION (DummyNS::UndefinedType)
template<class T >
RCPNodebasicRCPNodeNoAlloc (T *p, const bool has_ownership)
template<class T >
RCPNodebasicRCPNode (const bool has_ownership, T **p_out=0)
void deleteRCPNode (RCPNode **node)
template<class T >
RCPNodeHandle basicRCPNodeHandle (const bool has_ownership, T **p_out=0)
 TEUCHOS_STATIC_SETUP ()
 TEUCHOS_UNIT_TEST (RCPNodeHandle, assignSelf)
 TEUCHOS_UNIT_TEST (RCPNodeHandle, defaultConstruct)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, basicConstruct_owns_mem, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, basicConstruct_no_owns_mem, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, weakPtr_basic_1, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, weakPtr_basic_2, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, copyConstruct, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, assignmentOperator, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, extraData_basic, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, extraData_basic_const, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, extraData_failed, T)
 TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL (RCPNodeHandle, extraData_failed_const, T)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, constructor)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setNames)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setObjectFactory)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setObjectFactory_bad)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, getObjectName)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, create)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setParameterList)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, getParameterList)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, getNonconstParameterList)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, unsetParameterList)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, getValidParameters)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, usedParameters)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setDefaultObject_withOneUsePL)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setDefaultObject_withMultipleUsePL)
 TEUCHOS_UNIT_TEST (Teuchos_ObjectBuilder, setDefaultObject_withoutPL)
 TEUCHOS_UNIT_TEST (Teuchos_ParameterList, operatorEqualityWithEmpty)
 TEUCHOS_UNIT_TEST (Teuchos_ParameterList, operatorEqualityDifferentSublistNames)
 TEUCHOS_UNIT_TEST (Teuchos_ParameterList, operatorEqualityDifferentLengths)
 TEUCHOS_UNIT_TEST (Teuchos_ParameterList, haveSameValuesWithEmpty)
 TEUCHOS_UNIT_TEST (Teuchos_ParameterList, haveSameValuesDifferentSublistNames)
 TEUCHOS_UNIT_TEST (TimeMonitor, FUNC_TIME_MONITOR)
 TEUCHOS_UNIT_TEST (TimeMonitor, FUNC_TIME_MONITOR_tested)

Variables

TEUCHOS_LIB_DLL_EXPORT const char ESideChar [] = {'L' , 'R' }
TEUCHOS_LIB_DLL_EXPORT const char ETranspChar [] = {'N' , 'T' , 'C' }
TEUCHOS_LIB_DLL_EXPORT const char EUploChar [] = {'U' , 'L' }
TEUCHOS_LIB_DLL_EXPORT const char EDiagChar [] = {'U' , 'N' }
const std::string ObjectType_name = "Foo Type"

Typedef Documentation

Definition at line 711 of file Teuchos_FancyOStream.hpp.

typedef basic_OSTab<char> Teuchos::OSTab

Definition at line 717 of file Teuchos_FancyOStream.hpp.

typedef basic_oblackholestream<char,std::char_traits<char> > Teuchos::oblackholestream

Definition at line 38 of file Teuchos_oblackholestream.hpp.


Enumeration Type Documentation

Enumerator:
LEFT_SIDE 

Left side

RIGHT_SIDE 

Right side

Definition at line 45 of file Teuchos_BLAS_types.hpp.

Enumerator:
NO_TRANS 

Not transposed

TRANS 

Transposed

CONJ_TRANS 

Conjugate transposed

Definition at line 50 of file Teuchos_BLAS_types.hpp.

Enumerator:
UPPER_TRI 

Upper triangular

LOWER_TRI 

Lower triangular

Definition at line 56 of file Teuchos_BLAS_types.hpp.

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 54 of file Teuchos_CommHelpers.hpp.

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.

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

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

Enumerator:
null 

Definition at line 41 of file Teuchos_ENull.hpp.

enum EValidateUsed [related, inherited]

Enumerator:
VALIDATE_USED_ENABLED 
VALIDATE_USED_DISABLED 

Definition at line 53 of file Teuchos_ParameterList.hpp.

enum EValidateDefaults [related, inherited]

Enumerator:
VALIDATE_DEFAULTS_ENABLED 
VALIDATE_DEFAULTS_DISABLED 

Definition at line 65 of file Teuchos_ParameterList.hpp.

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

Enumerator:
ELocal 
ETotal 
EMin 
EMax 
EAvg 

Definition at line 48 of file Teuchos_PerformanceMonitorUtils.hpp.

Enumerator:
RCP_WEAK_NO_DEALLOC 

Definition at line 62 of file Teuchos_RCPDecl.hpp.

Enumerator:
RCP_UNDEFINED_WEAK_NO_DEALLOC 

Definition at line 63 of file Teuchos_RCPDecl.hpp.

Enumerator:
RCP_UNDEFINED_WITH_DEALLOC 

Definition at line 64 of file Teuchos_RCPDecl.hpp.

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

Enumerator:
PRE_DESTROY 
POST_DESTROY 

Definition at line 57 of file Teuchos_RCPNode.hpp.

Used to specify if the pointer is weak or strong.

Enumerator:
RCP_STRENGTH_INVALID 
RCP_STRONG 
RCP_WEAK 

Definition at line 63 of file Teuchos_RCPNode.hpp.

Used to determine if RCPNode lookup is performed or not.

Enumerator:
RCP_ENABLE_NODE_LOOKUP 
RCP_DISABLE_NODE_LOOKUP 

Definition at line 69 of file Teuchos_RCPNode.hpp.

Enumerator:
SHOW_TEST_DETAILS_ALL 
SHOW_TEST_DETAILS_TEST_NAMES 
SHOW_TEST_DETAILS_FINAL_RESULTS 

Definition at line 96 of file Teuchos_UnitTestRepository.cpp.

Verbosity level.

Enumerator:
VERB_DEFAULT 

Generate output as defined by the object.

VERB_NONE 

Generate no output.

VERB_LOW 

Generate only a minimal amount of output.

VERB_MEDIUM 

Generate more output.

VERB_HIGH 

Generate a high level of output.

VERB_EXTREME 

Generate the most output possible.

Definition at line 48 of file Teuchos_VerbosityLevel.hpp.


Function Documentation

template<class ArrayPtrT_in , class T_out >
void Teuchos::arrayViewPtrConv ( const ArrayPtrT_in &  a_in,
const ArrayView< Ptr< T_out > > &  a_out 
) [inline]

Utility function to convert from an an input Array[View,RCP]<[const] PTR<T_in> > object to an output ArrayView<Ptr<T_out> > object.

Definition at line 47 of file Teuchos_ArrayConversions.hpp.

template<class ArrayPtrT_in , class T_out >
void Teuchos::arrayViewRcpConv ( const ArrayPtrT_in &  a_in,
const ArrayView< RCP< T_out > > &  a_out 
) [inline]

Utility function to convert from an input Array[View,RCP]<[const] RCP<T_in> > object to an output ArrayView<RCP<T_out> > object.

Definition at line 65 of file Teuchos_ArrayConversions.hpp.

template<class T_out , class ArrayPtrT_in >
Array<Ptr<T_out> > Teuchos::arrayPtrConv ( const ArrayPtrT_in &  a_in  )  [inline]

Utility function to convert an Array[View,RCP]<[const] PTR<T_in> > object to an Array<Ptr<T_out> > object.

The input array type can be Array, ArrayView, ArrayRCP, or any other array object that supports size() and operator[](const int).

The reason that the while array input type is a template argument instead of just passing in ArrayView templated on the pointer type is that implicit conversions of the array input type will not take place unless you specify the type of the input. That is painful and verbose and we can avoid this by just templating the entire array type as is done here.

NOTE: This function will convert from base type to derived types as well.

NOTE: This function will perform dynamic memory allocation in the creation of the returned Array<Ptr<T_out> > object. However, this should not be a significant performance disadvantage because typically any class type that you would manipulate through an RCP or Ptr object would tend to be larger an more complex so that such overhead would be small and insignificant.

Definition at line 100 of file Teuchos_ArrayConversions.hpp.

template<class T_out , class ArrayPtrT_in >
Array<RCP<T_out> > Teuchos::arrayRcpConv ( const ArrayPtrT_in &  a_in  )  [inline]

Utility function to convert any Array[View,RCP]<[const] RCP<T_in> > object to an Array<RCP<T_out> > object.

Similar to the function arrayPtrConv() except this function returns Array<RCP<T_out> > objects instead of Array<Ptr<T_out> > objects.

Definition at line 116 of file Teuchos_ArrayConversions.hpp.

template<class T >
ArrayView<const Ptr<const T> > Teuchos::arrayConstPtrConstCast ( const ArrayView< const Ptr< T > > &  a_in  )  [inline]

Utility function that does a reinterpret case to convert an ArrayView<const Ptr<T> > object to an ArrayView<const Ptr<const T> > object.

Making this conversion requires an reinterpret case since Ptr<T> is not exactly the same thing as a raw pointer but this conversion should be 100 percent portable and safe.

Definition at line 137 of file Teuchos_ArrayConversions.hpp.

template<class T >
ArrayView<const RCP<const T> > Teuchos::arrayConstRcpConstCast ( const ArrayView< const RCP< T > > &  a_in  )  [inline]

Utility function that does a reinterpret case to convert an ArrayView<const RCP<T> > object to an ArrayView<const RCP<const T> > object.

Making this conversion requires an reinterpret case since RCP<T> is not exactly the same thing as a raw pointer but this conversion should be 100 percent portable and safe.

Definition at line 155 of file Teuchos_ArrayConversions.hpp.

template<class T >
RCPNode* Teuchos::ArrayRCP_createNewRCPNodeRawPtr ( T *  p,
bool  has_ownership_in 
) [inline]

Definition at line 47 of file Teuchos_ArrayRCP.hpp.

template<class T , class Dealloc_T >
RCPNode* Teuchos::ArrayRCP_createNewDeallocRCPNodeRawPtr ( T *  p,
Dealloc_T  dealloc,
bool  has_ownership_in 
) [inline]

Definition at line 57 of file Teuchos_ArrayRCP.hpp.

template<class TypeTo , class TypeFrom >
TypeTo Teuchos::as ( const TypeFrom &  t  )  [inline]

Perform an debug-enabled checked conversion from one value type object to another.

This function is used as:

    TypeTo myConversion( const TypeFrom& a )
    {
      return Teuchos::as<TypeTo>(a);
    }

This is just an interface function what calls the traits class ValueTypeConversionTraits to perform the actual conversion. All specializations of behavior is done through specializations of the ValueTypeConversionTraits class (which should be done in the Teuchos namespace).

When debug checking is turned on (e.g. when the TEUCHOS_DEBUG macro is defined by the --enable-teuchos-debug configure option), then the checked conversion function ValueTypeConversionTraits<TypeTo,TypeFrom>::safeConvert(t) is called. When debug checking is not turned on, the unchecked ValueTypeConversionTraits<TypeTo,TypeFrom>::convert(t) function is called.

For cases where the checking should always be done (i.e. to validate user data), use the asSafe() version of this function.

Definition at line 118 of file Teuchos_as.hpp.

template<class TypeTo , class TypeFrom >
TypeTo Teuchos::asSafe ( const TypeFrom &  t  )  [inline]

Perform an always checked conversion from one value type object to another.

This function is used as:

    TypeTo mySafeConversion( const TypeFrom& a )
    {
      return Teuchos::asSafe<TypeTo>(a);
    }

This is just an interface function what calls the traits class ValueTypeConversionTraits to perform the actual conversion. All specializations of behavior is done through specializations of the ValueTypeConversionTraits class (which should be done in the Teuchos namespace).

This function always calls ValueTypeConversionTraits<TypeTo,TypeFrom>::safeConvert(t) independent of whether TEUCHOS_DEBUG is defined or not, which ensures that the conversions are always runtime checked and therefore well defined.

For cases where the checking should only be done in a debug build, use the the as() version of this function.

Definition at line 158 of file Teuchos_as.hpp.

template<typename Ordinal , typename Packet >
TEUCHOS_DEPRECATED void Teuchos::reduceAll ( const Comm< Ordinal > &  comm,
const EReductionType  reductType,
const Packet &  send,
Packet *  globalReduct 
) [inline]

Deprecated .

Definition at line 220 of file Teuchos_CommHelpers.hpp.

template<typename Ordinal , typename Packet >
TEUCHOS_DEPRECATED void Teuchos::scan ( const Comm< Ordinal > &  comm,
const EReductionType  reductType,
const Packet &  send,
Packet *  scanReduct 
) [inline]

Deprecated.

Definition at line 312 of file Teuchos_CommHelpers.hpp.

template<typename Ordinal , typename Packet >
ValueTypeReductionOp<Ordinal,Packet>* Teuchos::createOp ( const EReductionType  reductType  )  [inline]

Definition at line 783 of file Teuchos_CommHelpers.hpp.

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<class T_To , class T_From >
T_To& Teuchos::dyn_cast ( T_From &  from  )  [inline]

Dynamic casting utility function meant to replace dynamic_cast<T&> by throwing a better documented error message.

Existing uses of the built-in dynamic_cast<T&>() operator such as:

 C &c = dynamic_cast<C&>(a);

are easily replaced as:

 C &c = dyn_cast<C>(a);

and that is it. One could write a perl script to do this automatically.

This utility function is designed to cast an object reference of type T_From to type T_To and if the cast fails at runtime then an std::exception (derived from std::bad_cast) is thrown that contains a very good error message.

Consider the following class hierarchy:

 class A {};
 class B : public A {};
 class C : public A {};

Now consider the following program:

  int main( int argc, char* argv[] ) {
    B b;
    A &a = b;
    try {
      std::cout << "\nTrying: dynamic_cast<C&>(a);\n";
      dynamic_cast<C&>(a);
    }
    catch( const std::bad_cast &e ) {
      std::cout << "\nCaught std::bad_cast std::exception e where e.what() = \"" << e.what() << "\"\n";
    }
    try {
      std::cout << "\nTrying: Teuchos::dyn_cast<C>(a);\n";
      Teuchos::dyn_cast<C>(a);
    }
    catch( const std::bad_cast &e ) {
      std::cout << "\nCaught std::bad_cast std::exception e where e.what() = \"" << e.what() << "\"\n";
    }
    return 0;
  }

The above program will print something that looks like (compiled with g++ for example):


  Trying: dynamic_cast<C&>(a);

  Caught std::bad_cast std::exception e where e.what() = "St8bad_cast"

  Trying: Teuchos::dyn_cast<C>(a);

  Caught std::bad_cast std::exception e where e.what() = "../../../../packages/teuchos/src/Teuchos_dyn_cast.cpp:46: true:
  dyn_cast<1C>(1A) : Error, the object with the concrete type '1B' (passed in through the interface type '1A')  does
  not support the interface '1C' and the dynamic cast failed!"

 

The above program shows that the standard implementation of dynamic_cast<T&>() does not return any useful debugging information at all but the templated function Teuchos::dyn_cast<T>() returns all kinds of useful information. The generated error message gives the type of the interface that the object was passed in as (i.e. A), what the actual concrete type of the object is (i.e. B) and what type is trying to be dynamically casted to (i.e. C). This type of information is extremely valuable when trying to track down these type of runtime dynamic casting errors. In some cases (such as with gdb), debuggers do not even give the type of concrete object so this function is very important on these platforms. In many cases, a debugger does not even need to be opened to diagnose what the problem is and how to fix it.

Note that this function is inlined and does not incur any significant runtime performance penalty over the raw dynamic_cast<T&>() operator.

Definition at line 160 of file Teuchos_dyn_cast.hpp.

template<class T >
const T& Teuchos::getConst ( T &  t  )  [inline]

Return a constant reference to an object given a non-const reference.

This function just provides a shorthand notation for

const_cast<const T&>(t) 

as

getCost(t) 

so that one does not have to type in the name of the class which can be quite long in some cases.

Definition at line 48 of file Teuchos_getConst.hpp.

template<class Container >
RawPointerConversionTraits<Container>::Ptr_t Teuchos::getRawPtr ( const Container &  c  )  [inline]

Definition at line 44 of file Teuchos_getRawPtr.hpp.

template<class Key >
std::string Teuchos::toString ( const HashSet< Key > &  h  )  [inline]

Definition at line 97 of file Teuchos_HashSet.hpp.

template<class Key >
std::ostream& Teuchos::operator<< ( std::ostream &  os,
const HashSet< Key > &  h 
) [related]

Definition at line 253 of file Teuchos_HashSet.hpp.

template<class Key , class Value >
std::string Teuchos::toString ( const Hashtable< Key, Value > &  h  )  [inline]

Definition at line 246 of file Teuchos_Hashtable.hpp.

template<class Key , class Value >
std::ostream& Teuchos::operator<< ( std::ostream &  os,
const Hashtable< Key, Value > &  h 
) [related]

Definition at line 324 of file Teuchos_Hashtable.hpp.

template<class TypeTo , class TypeFrom >
TypeTo Teuchos::implicit_cast ( const TypeFrom &  t  )  [inline]

Perform an implicit cast of concrete types with the casted object returned by value.

This function is used as:

    TypeTo myCast( const TypeFrom& a )
    {
      return Teuchos::implicit_cast<TypeTo>(a);
    }

This function will only compile for types where an implicit conversion from objects of type TypeFrom to type TypeTo exists. Note that this is a weaker operation than a static_cast<TypeTo>(t) in that the static cast will actually compile in cases where the implicit conversion would not compile and may result in incorrect code. This function can not result in incorrect code, assuming that the implicit conversions themselves do no result in incorrect code (which is another matter all together).

This function is especially helpful when one needs to be careful of what specific type is passed in as a formal argument to a function and in comparing values. In particular, using this function is far safer than using TypeTo(t) in cases where TypeTo is a built in type since TypeTo(t) in these cases is equivalent to (TypeTo)t which is an unchecked sledge-hammer cast of the worst kind.

Definition at line 68 of file Teuchos_implicit_cast.hpp.

template<class TypeTo , class TypeFrom >
TypeTo& Teuchos::implicit_ref_cast ( TypeFrom &  t  )  [inline]

Perform an implicit cast of reference types with a reference being returned.

This function is used as:

    TypeTo& myPtrCast( TypeFrom &ref1 )
    {
      return Teuchos::implicit_ref_cast<TypeTo>(ref1);
    }

This function will only compile for types where an implicit conversion from references of type TypeFrom& to references of TypeTo& exists. It is allowed for the type TypeFrom and TypeTo to actually be const types. For example, we can have TypeFrom = const std::iostream and TypeTo = const std::ostream and Teuchos::implicit_ref_cast<const std::ostream>(Teuchos::getConst(std::cout)) would compile just fine.

Note that this is a weaker operation than a static_cast<TypeTo&>(t) in that the static cast will actually compile in cases where the implicit conversion would not compile and may result in incorrect code. For example, a static cast from a base to a derived class will compile (and may be wrong) while this implicit cast function will not compile for casts from base to derived classes. This function can not result in incorrect code, assuming that the implicit conversions themselves do no result in incorrect code (which is another matter all together).

Definition at line 103 of file Teuchos_implicit_cast.hpp.

template<class TypeTo , class TypeFrom >
TypeTo* Teuchos::implicit_ptr_cast ( TypeFrom *  t  )  [inline]

Perform an implicit cast of pointer types with a pointer being returned.

This function is used as:

    TypeTo* myPtrCast( TypeFrom *ptr1 )
    {
      return Teuchos::implicit_ptr_cast<TypeTo>(ptr1);
    }

This function will only compile for types where an implicit conversion from pointers of type TypeFrom* to pointers of type TypeTo* exists. It is allowed for the type TypeFrom and TypeTo to actually be const types. For example, we can have TypeFrom = const std::iostream and TypeTo = const std::ostream and Teuchos::implicit_ptr_cast<const std::ostream>(&Teuchos::getConst(std::cout)) would compile just fine.

Note that this is a weaker operation than a static_cast<TypeTo*>(t) in that the static cast will actually compile in cases where the implicit conversion would not compile and may result in incorrect code. For example, a static cast up from a base class to a derived class will compile (and may be wrong) while this implicit cast function will not compile for such casts. This function can not result in incorrect code, assuming that the implicit conversions themselves do no result in incorrect code (which is another matter all together).

Definition at line 137 of file Teuchos_implicit_cast.hpp.

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

Create an MpiReductionOp object given an ReductionOp object.

Definition at line 180 of file Teuchos_MpiReductionOpSetter.hpp.

template<class ObjectType >
RCP<ObjectBuilder<ObjectType> > Teuchos::objectBuilder (  )  [inline]

Definition at line 169 of file Teuchos_ObjectBuilder.hpp.

template<class ObjectType >
RCP<ObjectBuilder<ObjectType> > Teuchos::objectBuilder ( const std::string &  objectName,
const std::string &  objectTypeName 
) [inline]

Definition at line 178 of file Teuchos_ObjectBuilder.hpp.

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

Nonmember constructor.

Definition at line 582 of file Teuchos_ParameterList.hpp.

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

Nonmember constructor.

Definition at line 590 of file Teuchos_ParameterList.hpp.

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

Nonmember constructor.

Definition at line 597 of file Teuchos_ParameterList.hpp.

void Teuchos::printValidParameters ( const ParameterListAcceptor &  paramListAccpetor,
std::ostream &  out,
const bool  showDoc = true 
)

Pretty print the valid parameters from a ParameterListAccpetor object.

Definition at line 35 of file Teuchos_ParameterListAcceptorHelpers.cpp.

template<class T >
RCPNode* Teuchos::RCP_createNewRCPNodeRawPtrNonowned ( T *  p  )  [inline]

Definition at line 481 of file Teuchos_RCP.hpp.

template<class T >
RCPNode* Teuchos::RCP_createNewRCPNodeRawPtrNonownedUndefined ( T *  p  )  [inline]

Definition at line 489 of file Teuchos_RCP.hpp.

template<class T >
RCPNode* Teuchos::RCP_createNewRCPNodeRawPtr ( T *  p,
bool  has_ownership_in 
) [inline]

Definition at line 497 of file Teuchos_RCP.hpp.

template<class T , class Dealloc_T >
RCPNode* Teuchos::RCP_createNewDeallocRCPNodeRawPtr ( T *  p,
Dealloc_T  dealloc,
bool  has_ownership_in 
) [inline]

Definition at line 505 of file Teuchos_RCP.hpp.

template<class T , class Dealloc_T >
RCPNode* Teuchos::RCP_createNewDeallocRCPNodeRawPtrUndefined ( T *  p,
Dealloc_T  dealloc,
bool  has_ownership_in 
) [inline]

Definition at line 515 of file Teuchos_RCP.hpp.

template<class T , class Dealloc_T >
RCP<T> Teuchos::rcp ( T *  p,
Dealloc_T  dealloc,
bool  owns_mem 
) [inline]

Deprecated.

Definition at line 1184 of file Teuchos_RCPDecl.hpp.

template<class T , class Embedded >
Teuchos::RCP< T > Teuchos::rcpWithEmbeddedObjPreDestroy ( T *  p,
const Embedded &  embedded,
bool  owns_mem = true 
) [inline]

Definition at line 600 of file Teuchos_RCP.hpp.

template<class T , class Embedded >
Teuchos::RCP< T > Teuchos::rcpWithEmbeddedObjPostDestroy ( T *  p,
const Embedded &  embedded,
bool  owns_mem = true 
) [inline]

Definition at line 612 of file Teuchos_RCP.hpp.

template<class T , class Embedded >
Teuchos::RCP< T > Teuchos::rcpWithEmbeddedObj ( T *  p,
const Embedded &  embedded,
bool  owns_mem = true 
) [inline]

Definition at line 622 of file Teuchos_RCP.hpp.

template<class T , class ParentT >
Teuchos::RCP< T > Teuchos::rcpWithInvertedObjOwnership ( const RCP< T > &  child,
const RCP< ParentT > &  parent 
) [inline]

Create a new RCP that inverts the ownership of parent and child.

This implements the "inverted object ownership" idiom.

NOTE: The parent can be retrieved using the function getInvertedObjOwnershipParent(...).

Definition at line 630 of file Teuchos_RCP.hpp.

template<class ParentT , class T >
Teuchos::RCP< ParentT > Teuchos::getInvertedObjOwnershipParent ( const RCP< T > &  invertedChild  )  [inline]

Get the parent back from an inverted ownership RCP.

Retrieves the RCP<ParentT> object set through rcpWithInvertedObjOwnership().

Definition at line 904 of file Teuchos_RCP.hpp.

void Teuchos::debugAssertStrength ( ERCPStrength  strength  )  [inline]

Definition at line 72 of file Teuchos_RCPNode.hpp.

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

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

This function with thrown of the validator does not exist.

Definition at line 1130 of file Teuchos_StandardParameterEntryValidators.hpp.

void Teuchos::updateSuccess ( const bool  result,
bool &  success 
) [inline]

Update the success bool flag.

Definition at line 468 of file Teuchos_TestingHelpers.hpp.

const std::string Teuchos::passfail ( const bool  result  )  [inline]

Return "passed" or "failed".

Definition at line 476 of file Teuchos_TestingHelpers.hpp.

const std::string Teuchos::passfail_with_location ( const bool  result,
const std::string &  file,
const int  lineNumber 
)

Helper function for TEUCHOS_PASS_FAIL(...).

Definition at line 48 of file Teuchos_TestingHelpers.cpp.

void Teuchos::showTestFailureLocation ( bool  showTFL  ) 

Set if TEUCHOS_PASS_FAIL(...) should print test failure location.

Definition at line 59 of file Teuchos_TestingHelpers.cpp.

bool Teuchos::showTestFailureLocation (  ) 

Return if TEUCHOS_PASS_FAIL(...) should print test failure location.

Definition at line 65 of file Teuchos_TestingHelpers.cpp.

template<class Scalar >
Scalar Teuchos::defaultSmallNumber (  )  [inline]

Definition at line 128 of file Teuchos_TestingHelpers.hpp.

template<class Scalar >
Teuchos::ScalarTraits< Scalar >::magnitudeType Teuchos::relErr ( const Scalar &  s1,
const Scalar &  s2 
) [inline]

Return relative error of two scalars.

ToDo: Finish documentation!

Definition at line 486 of file Teuchos_TestingHelpers.hpp.

template<class Scalar >
bool Teuchos::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 
) [inline]

Compute, check and optionally print the relative error in two scalars.

ToDo: Finish documentation!

Definition at line 501 of file Teuchos_TestingHelpers.hpp.

template<class Array1 , class Array2 >
bool Teuchos::compareArrays ( const Array1 &  a1,
const std::string &  a1_name,
const Array2 &  a2,
const std::string &  a2_name,
Teuchos::FancyOStream out 
) [inline]

Compare if two array objects are the same or not.

This function works with any two array objects are the same size and have the same element value types. The funtion is templated on the container types and therefore can compare any two objects that have size() and operator[](i) defined.

Returns:
Returns true if the compare and false otherwise.

Definition at line 542 of file Teuchos_TestingHelpers.hpp.

template<class Array1 , class Array2 , class ScalarMag >
bool Teuchos::compareFloatingArrays ( const Array1 &  a1,
const std::string &  a1_name,
const Array2 &  a2,
const std::string &  a2_name,
const ScalarMag &  tol,
Teuchos::FancyOStream out 
) [inline]

Compare if two array objects are the same or not up to a relative floating point precision.

This function works with any two array objects are the same size and have the same element value types. The funtion is templated on the container types and therefore can compare any two objects that have size() and operator[](i) defined.

Returns:
Returns true if the compare and false otherwise.

Definition at line 581 of file Teuchos_TestingHelpers.hpp.

template<typename T >
std::string Teuchos::toString ( const T &  t  )  [inline]

Utility function for returning a pretty string representation of a object of type T.

NOTE: This helper function simply returns ToStringTraits<T>::toString(t) and the right way to speicalize the behavior is to specialize ToStringTraits.

Definition at line 68 of file Teuchos_toString.hpp.

std::string Teuchos::demangleName ( const std::string &  mangledName  ) 

Demangle a C++ name if valid.

The name must have come from typeid(...).name() in order to be valid name to pass to this function.

Definition at line 40 of file Teuchos_TypeNameTraits.cpp.

template<typename T >
std::string Teuchos::typeName ( const T &  t  )  [inline]

Template function for returning the concrete type name of a passed-in object.

Uses the traits class TypeNameTraits so the behavior of this function can be specialized in every possible way. The default return value is typically derived from typeid(t).name().

Definition at line 91 of file Teuchos_TypeNameTraits.hpp.

template<typename T >
std::string Teuchos::concreteTypeName ( const T &  t  )  [inline]

Template function for returning the type name of the actual concrete name of a passed-in object.

Uses the traits class TypeNameTraits so the behavior of this function can be specialized in every possible way.

Definition at line 114 of file Teuchos_TypeNameTraits.hpp.

Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( bool   ) 
Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( char   ) 
Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( int   ) 
Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( short  int  ) 
Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( long  int  ) 
Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( float   ) 
Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( double   ) 
bool Teuchos::operator< ( const UnitTestData &  a,
const UnitTestData &  b 
)

Definition at line 74 of file Teuchos_UnitTestRepository.cpp.

std::string Teuchos::getUnitTestName ( const std::string  groupName,
const std::string  testName 
)

Definition at line 87 of file Teuchos_UnitTestRepository.cpp.

bool Teuchos::strMatch ( const std::string &  fullMatchStr,
const std::string &  str 
)

Definition at line 103 of file Teuchos_UnitTestRepository.cpp.

std::string Teuchos::toString ( const EVerbosityLevel  verbLevel  ) 

Return a std::string representation of the verbosity level.

Definition at line 51 of file Teuchos_VerbosityLevel.cpp.

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.

Teuchos::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.

std::string Teuchos::Teuchos_Version (  ) 

Definition at line 37 of file Teuchos_Version.hpp.

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 36 of file Teuchos_XMLParameterListHelpers.cpp.

Teuchos::RCP< Teuchos::ParameterList > Teuchos::getParametersFromXmlFile ( const std::string &  xmlFileName  ) 

Reads XML parameters from a file and return them in a new parameter list.

Parameters:
xmlFileName [in] The file name containing XML parameter list specification.

Definition at line 50 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 57 of file Teuchos_XMLParameterListHelpers.cpp.

Teuchos::RCP< Teuchos::ParameterList > Teuchos::getParametersFromXmlString ( const std::string &  xmlStr  ) 

Reads XML parameters from a std::string and return them in a new parameter list.

Parameters:
xmlStr [in] String containing XML parameter list specification.

Definition at line 71 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 79 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 90 of file Teuchos_XMLParameterListHelpers.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
create   
)

Definition at line 35 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
DefaultConstruct   
)

Definition at line 43 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
NonconstConstruct   
)

Definition at line 52 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
ConstConstruct   
)

Definition at line 63 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
NonconstInitialize   
)

Definition at line 74 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
ConstInitialize   
)

Definition at line 86 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
AssignmentFromRCP   
)

Definition at line 98 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
uninitialize   
)

Definition at line 110 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
parens   
)

Definition at line 122 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
arrow   
)

Definition at line 132 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
arrowEmpty   
)

Definition at line 141 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
dereference   
)

Definition at line 150 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
dereferenceEmpty   
)

Definition at line 160 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
castToRCP   
)

Definition at line 171 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
castFromRCP   
)

Definition at line 184 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
is_null   
)

Definition at line 191 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( ConstNonconstObjectContainer  ,
nonnull   
)

Definition at line 197 of file ConstNonconstObjectContainer.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( GetBaseObjVoidPtr  ,
polymorphicClasses   
)

Definition at line 12 of file GetBaseObjVoidPtr_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( GetBaseObjVoidPtr  ,
nonPolymorphicClasses   
)

Definition at line 28 of file GetBaseObjVoidPtr_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( GetBaseObjVoidPtr  ,
nonPolymorphicBuiltInTypes   
)

Definition at line 37 of file GetBaseObjVoidPtr_UnitTests.cpp.

Teuchos::TEUCHOS_TYPE_NAME_TRAITS_BUILTIN_TYPE_SPECIALIZATION ( DummyNS::UndefinedType   ) 
template<class T >
RCPNode* Teuchos::basicRCPNodeNoAlloc ( T *  p,
const bool  has_ownership 
) [inline]

Definition at line 22 of file RCPNodeHandle_UnitTests.cpp.

template<class T >
RCPNode* Teuchos::basicRCPNode ( const bool  has_ownership,
T **  p_out = 0 
) [inline]

Definition at line 31 of file RCPNodeHandle_UnitTests.cpp.

void Teuchos::deleteRCPNode ( RCPNode **  node  ) 

Definition at line 41 of file RCPNodeHandle_UnitTests.cpp.

template<class T >
RCPNodeHandle Teuchos::basicRCPNodeHandle ( const bool  has_ownership,
T **  p_out = 0 
) [inline]

Definition at line 52 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_STATIC_SETUP (  ) 

Definition at line 66 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( RCPNodeHandle  ,
assignSelf   
)

Definition at line 76 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( RCPNodeHandle  ,
defaultConstruct   
)

Definition at line 83 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
basicConstruct_owns_mem  ,
 
)

Definition at line 276 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
basicConstruct_no_owns_mem  ,
 
)

Definition at line 298 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
weakPtr_basic_1  ,
 
)

Definition at line 308 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
weakPtr_basic_2  ,
 
)

Definition at line 355 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
copyConstruct  ,
 
)

Definition at line 496 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
assignmentOperator  ,
 
)

Definition at line 507 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
extraData_basic  ,
 
)

Definition at line 519 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
extraData_basic_const  ,
 
)

Definition at line 552 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
extraData_failed  ,
 
)

Definition at line 575 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL ( RCPNodeHandle  ,
extraData_failed_const  ,
 
)

Definition at line 603 of file RCPNodeHandle_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
constructor   
)

Definition at line 160 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setNames   
)

Definition at line 172 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setObjectFactory   
)

Definition at line 220 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setObjectFactory_bad   
)

Definition at line 238 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
getObjectName   
)

Definition at line 262 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
create   
)

Definition at line 293 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setParameterList   
)

Definition at line 350 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
getParameterList   
)

Definition at line 376 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
getNonconstParameterList   
)

Definition at line 391 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
unsetParameterList   
)

Definition at line 412 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
getValidParameters   
)

Definition at line 444 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
usedParameters   
)

Definition at line 497 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setDefaultObject_withOneUsePL   
)

Definition at line 538 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setDefaultObject_withMultipleUsePL   
)

Definition at line 574 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ObjectBuilder  ,
setDefaultObject_withoutPL   
)

Definition at line 601 of file ObjectBuilder_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ParameterList  ,
operatorEqualityWithEmpty   
)

Definition at line 55 of file ParameterList_UnitTest.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ParameterList  ,
operatorEqualityDifferentSublistNames   
)

Definition at line 67 of file ParameterList_UnitTest.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ParameterList  ,
operatorEqualityDifferentLengths   
)

Definition at line 77 of file ParameterList_UnitTest.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ParameterList  ,
haveSameValuesWithEmpty   
)

Definition at line 94 of file ParameterList_UnitTest.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( Teuchos_ParameterList  ,
haveSameValuesDifferentSublistNames   
)

Definition at line 105 of file ParameterList_UnitTest.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( TimeMonitor  ,
FUNC_TIME_MONITOR   
)

Definition at line 9 of file TimeMonitor_UnitTests.cpp.

Teuchos::TEUCHOS_UNIT_TEST ( TimeMonitor  ,
FUNC_TIME_MONITOR_tested   
)

Definition at line 20 of file TimeMonitor_UnitTests.cpp.


Variable Documentation

const char Teuchos::ESideChar = {'L' , 'R' }

Definition at line 36 of file Teuchos_BLAS.cpp.

const char Teuchos::ETranspChar = {'N' , 'T' , 'C' }

Definition at line 37 of file Teuchos_BLAS.cpp.

const char Teuchos::EUploChar = {'U' , 'L' }

Definition at line 38 of file Teuchos_BLAS.cpp.

const char Teuchos::EDiagChar = {'U' , 'N' }

Definition at line 39 of file Teuchos_BLAS.cpp.

const std::string Teuchos::ObjectType_name = "Foo Type"

Definition at line 37 of file ObjectBuilder_UnitTests.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:36 2011 for Teuchos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3