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 | 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 | 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... | |
| 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 | 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... | |
| 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 | Object |
| The base Teuchos class. More... | |
| class | OpaqueWrapper |
| Base class for wrapped opaque objects. More... | |
| class | OpaqueWrapperWithFree |
| Subclass for wrapped opaque objects with a free function. More... | |
| struct | 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 | 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 | RCPNode |
| Node class to keep track of address and the reference count for a reference-counted utility class and delete the object. More... | |
| class | RCPNodeThrowDeleter |
| Deletes and RCPNode and its object in case of a throw. More... | |
| class | ActiveRCPNodesSetup |
| Print global list on destruction. More... | |
| class | RCPNodeTmpl |
| Implementation class for actually deleting the object. More... | |
| class | RCPNodeHandle |
| Utility handle class for handling the reference counting and managuement of the RCPNode object. More... | |
| class | ValueTypeReductionOp |
| Base interface class for user-defined reduction operations for objects that use value semantics. More... | |
| class | ReferenceTypeReductionOp |
| Base interface class for user-defined reduction operations for objects that use reference semantics. More... | |
| class | CharToValueTypeReductionOp |
Decorator class that uses traits to convert to and from char[] to typed buffers for objects that use value semantics and then call a type-specific reduction object. More... | |
| class | CharToReferenceTypeReductionOp |
Decorator class that uses a strategy object to convert to and from char[] to typed buffers for objects that use reference semantics and then call a type-specific reduction object. More... | |
| struct | 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... | |
| class | SerializationTraits |
| Serialization traits class for types that use value semantics. More... | |
| 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 | 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 | 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 | UnitTestBase |
| Unit test base class. More... | |
| 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... | |
| class | NullIteratorTraits< std::reverse_iterator< Iter > > |
| Partial specialization for std::reverse_iterator. More... | |
| class | ToStringTraits< std::string > |
| Specialization for std::string. 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 |
| More... | |
| enum | EValidateDefaults |
| 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 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 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> | |
| void | reduceAll (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *globalReduct) |
| Deprecated . | |
| template<typename Ordinal, typename Packet> | |
| void | scan (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *scanReduct) |
| Deprecated. | |
| 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 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. | |
| void | printValidParameters (const ParameterListAcceptor ¶mListAccpetor, std::ostream &out, const bool showDoc=true) |
| Pretty print the valid parameters from a ParameterListAccpetor object. | |
| template<class T> | |
| Teuchos::RCP< T > | rcp (const boost::shared_ptr< T > &sptr) |
Conversion function that takes in a boost::shared_ptr object and spits out a Teuchos::RCP object. | |
| template<class T> | |
| boost::shared_ptr< T > | shared_pointer (const RCP< T > &rcp) |
Conversion function that takes in a Teuchos::RCP object and spits out a boost::shared_ptr object. | |
| template<class T, class Dealloc_T> | |
| RCP< T > | rcp (T *p, Dealloc_T dealloc, bool owns_mem) |
| Deprecated. | |
| 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 ¶mList, std::string const ¶mName) |
| Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object. | |
| template<class IntegralType> | |
| Teuchos::RCP< const Teuchos::StringToIntegralParameterEntryValidator< IntegralType > > | getStringToIntegralParameterEntryValidator (ParameterEntry const &entry, ParameterList const ¶mList, std::string const ¶mName) |
| 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" 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. | |
| void | updateSuccess (const bool result, bool &success) |
| Update the success bool flag. | |
| const std::string | passfail (const bool result) |
| Return "passed" for "failed". | |
| template<class Scalar> | |
| Teuchos::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 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. | |
| std::string | toString (const EVerbosityLevel verbLevel) |
| Return a std::string representation of the verbosity level. | |
| bool | includesVerbLevel (const EVerbosityLevel verbLevel, const EVerbosityLevel requestedVerbLevel, const bool isDefaultLevel=false) |
| Return true if the verbosity level includes the given level. | |
| Teuchos::EVerbosityLevel | incrVerbLevel (const EVerbosityLevel inputVerbLevel, const int numLevels) |
| Return an increased or decreased verbosity level. | |
| void | set_default_workspace_store (const Teuchos::RCP< WorkspaceStore > &default_workspace_store) |
| Set pointer to global workspace object. | |
| Teuchos::RCP< Teuchos::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. | |
| Teuchos::RCP< Teuchos::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. | |
| Teuchos::RCP< Teuchos::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 ¶mList, std::ostream &xmlOut) |
| Write parameters and sublists in XML format to an std::ostream. | |
| void | writeParameterListToXmlFile (const Teuchos::ParameterList ¶mList, const std::string &xmlFileName) |
| Write parameters and sublist to an XML file. | |
| enum Teuchos::ESide |
| enum Teuchos::ETransp |
| enum Teuchos::EUplo |
| enum Teuchos::EDiag |
enum EReductionType [related, inherited] |
| enum Teuchos::DataAccess |
enum ENull [related, inherited] |
Used to initialize a RCP object to NULL using an implicit conversion!
enum EValidateUsed [related, inherited] |
enum EValidateDefaults [related, inherited] |
Types of reduction operations on performance metrics. Add other operations if you like.
| void Teuchos::arrayViewPtrConv | ( | const ArrayPtrT_in & | a_in, | |
| const ArrayView< Ptr< T_out > > & | a_out | |||
| ) |
| void Teuchos::arrayViewRcpConv | ( | const ArrayPtrT_in & | a_in, | |
| const ArrayView< RCP< T_out > > & | a_out | |||
| ) |
| Array<Ptr<T_out> > Teuchos::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.
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.
| ArrayView<const Ptr<const T> > Teuchos::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.
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.
| ArrayView<const RCP<const T> > Teuchos::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.
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.
| void Teuchos::reduceAll | ( | const Comm< Ordinal > & | comm, | |
| const EReductionType | reductType, | |||
| const Packet & | send, | |||
| Packet * | globalReduct | |||
| ) |
Deprecated .
| void Teuchos::scan | ( | const Comm< Ordinal > & | comm, | |
| const EReductionType | reductType, | |||
| const Packet & | send, | |||
| Packet * | scanReduct | |||
| ) |
Deprecated.
| 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.
| RCP< const MpiReductionOp< Ordinal > > Teuchos::mpiReductionOp | ( | const RCP< const ValueTypeReductionOp< Ordinal, char > > & | reductOp | ) |
Create an MpiReductionOp object given an ReductionOp object.
| RCP<ParameterList> Teuchos::parameterList | ( | ) | [inline] |
Nonmember constructor.
| RCP<ParameterList> Teuchos::parameterList | ( | const std::string & | name | ) | [inline] |
Nonmember constructor.
| RCP<ParameterList> Teuchos::parameterList | ( | const ParameterList & | source | ) | [inline] |
Nonmember constructor.
| void Teuchos::printValidParameters | ( | const ParameterListAcceptor & | paramListAccpetor, | |
| std::ostream & | out, | |||
| const bool | showDoc = true | |||
| ) |
Pretty print the valid parameters from a ParameterListAccpetor object.
| RCP<T> Teuchos::rcp | ( | T * | p, | |
| Dealloc_T | dealloc, | |||
| bool | owns_mem | |||
| ) |
Deprecated.
| int Teuchos::numActiveRCPNodes | ( | ) |
Print the number of active RCPNode objects being tracked.
| void Teuchos::throw_null_ptr_error | ( | const std::string & | type_name | ) |
Throw that a pointer passed into an RCP object is null.
| RCP<const StringToIntegralParameterEntryValidator<IntegralType> > Teuchos::getStringToIntegralParameterEntryValidator | ( | ParameterEntry const & | entry, | |
| ParameterList const & | paramList, | |||
| std::string const & | paramName | |||
| ) |
Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object.
This function with thrown of the validator does not exist.
| Teuchos::RCP<const Teuchos::StringToIntegralParameterEntryValidator<IntegralType> > Teuchos::getStringToIntegralParameterEntryValidator | ( | ParameterEntry const & | entry, | |
| ParameterList const & | paramList, | |||
| std::string const & | paramName | |||
| ) |
Get a StringToIntegralParameterEntryValidator<IntegralType> object out of a ParameterEntry object.
This function with thrown of the validator does not exist.
| 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 | |||
| ) |
Compute, check and optionally print the relative error in two scalars.
ToDo: Finish documentation!
| 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 | |||
| ) |
Compute, check and optionally print the relative error in two scalars.
ToDo: Finish documentation!
| bool Teuchos::includesVerbLevel | ( | const EVerbosityLevel | verbLevel, | |
| const EVerbosityLevel | requestedVerbLevel, | |||
| const bool | isDefaultLevel = false | |||
| ) |
Return true if the verbosity level includes the given level.
| 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. |
| EVerbosityLevel Teuchos::incrVerbLevel | ( | const EVerbosityLevel | inputVerbLevel, | |
| const int | numLevels | |||
| ) |
Return an increased or decreased verbosity level.
| inputVerbLevel | [in] The base verbosity level. | |
| numLevels | [in] The number of levels to increase (>0) or decrease (<0). |
| 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.
| 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. |
| RCP< ParameterList > Teuchos::getParametersFromXmlFile | ( | const std::string & | xmlFileName | ) |
Reads XML parameters from a file and return them in a new parameter list.
| xmlFileName | [in] The file name containing XML parameter list specification. |
| 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.
| 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. |
| RCP< ParameterList > Teuchos::getParametersFromXmlString | ( | const std::string & | xmlStr | ) |
Reads XML parameters from a std::string and return them in a new parameter list.
| xmlStr | [in] String containing XML parameter list specification. |
| void Teuchos::writeParameterListToXmlOStream | ( | const Teuchos::ParameterList & | paramList, | |
| std::ostream & | xmlOut | |||
| ) |
Write parameters and sublists in XML format to an std::ostream.
| paramList | [in] Contains the parameters and sublists that will be written to file. | |
| xmlOut | [in] The stream that will get the XML output. |
| void Teuchos::writeParameterListToXmlFile | ( | const Teuchos::ParameterList & | paramList, | |
| const std::string & | xmlFileName | |||
| ) |
Write parameters and sublist to an XML file.
| 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. |
1.4.7