Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Namespaces | Typedefs | Enumerations | Functions
Zoltan2_IntegerRangeList.hpp File Reference

Define IntegerRangeList validator. More...

#include <Zoltan2_config.h>
#include <Teuchos_ParameterEntryValidator.hpp>
#include <Teuchos_ValidatorXMLConverter.hpp>
#include <Teuchos_XMLObject.hpp>
#include <Teuchos_ValidatorMaps.hpp>
#include <Teuchos_DummyObjectGetter.hpp>
#include <Teuchos_StrUtils.hpp>
Include dependency graph for Zoltan2_IntegerRangeList.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Zoltan2::IntegerRangeListValidator< T >
 A ParameterList validator for integer range lists. More...
 
class  Zoltan2::IntegerRangeListValidator< T >
 A ParameterList validator for integer range lists. More...
 
class  Zoltan2::IntegerRangeListValidatorXMLConverter< Integral >
 XML conversion code for IntegerRangeListValidator. More...
 

Namespaces

 Zoltan2
 Created by mbenlioglu on Aug 31, 2020.
 

Typedefs

typedef Teuchos::RCP< const
Teuchos::Array< std::string > > 
ValidStringsList
 

Enumerations

enum  Zoltan2::RangeType { Zoltan2::RANGE_INCLUDES_ALL, Zoltan2::RANGE_IS_EMPTY, Zoltan2::RANGE_IS_LISTED, Zoltan2::NUM_RANGE_TYPES }
 Codes that indicate how to interpret the Array<int> representing the user's integer range list. More...
 

Functions

template<typename Integral >
bool Zoltan2::validIntegralRangeList (const Teuchos::Array< Integral > &vals)
 A helper function that indicates whether an array is a valid integer range list. More...
 
template<typename Integral >
bool Zoltan2::allValuesAreInRangeList (const Teuchos::Array< Integral > &vals)
 A helper function that determines if all values are in the list. More...
 
template<typename Integral >
bool Zoltan2::allValuesAreInRangeList (const Teuchos::ParameterEntry &e)
 A helper function that determines if all values are in the list. More...
 
template<typename Integral >
bool Zoltan2::noValuesAreInRangeList (const Teuchos::Array< Integral > &vals)
 A helper function that determines if no values are in the list. More...
 
template<typename Integral >
bool Zoltan2::noValuesAreInRangeList (const Teuchos::ParameterEntry &e)
 A helper function that determines if no values are in the list. More...
 
template<typename Integral >
bool Zoltan2::IsInRangeList (const Integral val, const Teuchos::Array< Integral > &valList, bool sorted=true)
 A helper function that determines if a value is in the list. More...
 
template<typename Integral >
bool Zoltan2::IsInRangeList (const Integral val, const Teuchos::ParameterEntry &e)
 A helper function that determines if a value is in the list. More...
 
template<typename Integral >
Teuchos::ArrayView< Integral > Zoltan2::getList (Teuchos::Array< Integral > &irl)
 A helper function that returns a view of the list. More...
 
template<typename Integral >
void Zoltan2::printIntegralRangeList (std::ostream &os, Teuchos::Array< Integral > &irl)
 A helper function that prints the meaning of an encoded integer range list. More...
 

Detailed Description

Define IntegerRangeList validator.

Definition in file Zoltan2_IntegerRangeList.hpp.

Typedef Documentation

typedef Teuchos::RCP<const Teuchos::Array<std::string> > ValidStringsList

Definition at line 69 of file Zoltan2_IntegerRangeList.hpp.