/usr/include/trilinos/Teuchos_StringToIntMap.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_STRING_TO_INT_MAP_HPP
#define TEUCHOS_STRING_TO_INT_MAP_HPP
#include "Teuchos_TestForException.hpp"
namespace Teuchos {
/** \brief Map a std::string to an enumeration.
*
* The purpose of this class is to simplify mapping a standard std::string
* to an integer which can be interpreted as an enumeration.
*
* Here is an example of its use.
\verbatim
const int n_opt = 3;
enum MyOptEnum {
OPT_ONE
,OPT_TWO
,OPT_THREE
}; // NOTE: Must be 0, 1,..., n_opt - 1
const char* MyOptStrings[n_opt] = {
"OPT_ONE
,"OPT_TWO"
,"OPT_THREE"
}; // NOTE: parallels enums in MyOptEnum
StringToIntMap my_enum_map( "opt_map", n_opt, NyOptStrings );
...
switch( my_enum_map.get<MyOptEnum>("OPT_ONE") ) {
case OPT_ONE:
// do stuff
case OPT_TWO:
// do stuff
case OPT_THREE:
// do stuff
default:
// ???
}
\endverbatim
*
* The number of strings passed to the constructor must equal the number of
* options in the enumeration. If there are duplicate strings
* (capitalization concidered) then the std::exception <tt>AlreadyExists</tt> is
* throw. If a std::string that was not passed in the constructor if given to
* <tt>operator()( const std::string& str )</tt> then the std::exception
* <tt>DoesNotExist</tt> is thrown.
*
* In the constructor, <tt>defaultGroupName</tt> is used in error messages in
* the exceptions thrown to help make since out of the message.
*
* The default constructor is not defined and not to be called.
*/
class StringToIntMap {
public:
/** \brief . */
class AlreadyExists : public std::logic_error
{public: AlreadyExists(const std::string& what_arg) : std::logic_error(what_arg) {}};
/** \brief . */
class DoesNotExist : public std::logic_error
{public: DoesNotExist(const std::string& what_arg) : std::logic_error(what_arg) {}};
/** \brief . */
StringToIntMap( const std::string& defaultGroupName, int n, const char* strings[] );
/** \brief . */
int get( const std::string& option, const std::string& groupName = "" ) const;
/** \brief . */
template<class EnumType>
EnumType get( const std::string& option, const std::string& groupName = "" ) const;
/** \brief . */
const std::string& defaultGroupName() const;
private:
typedef std::map< std::string, int > map_t; // all share implementation.
std::string defaultGroupName_;
map_t map_;
std::string validSelections() const;
// not defined and not to be called.
StringToIntMap();
}; // end class StringToIntMap
/** \brief Nonmember get function.
* \relates StringToIntMap
*/
template<class EnumType>
inline
EnumType get(
StringToIntMap const& theMap
,std::string const& option
,std::string const& groupName = ""
)
{
return static_cast<EnumType>(theMap.get(option,groupName));
}
// ////////////////////////////////////////////
// Inline declarations
template<class EnumType>
inline
EnumType StringToIntMap::get( const std::string& option, const std::string& groupName ) const
{
return static_cast<EnumType>(get(option,groupName));
}
inline
const std::string& StringToIntMap::defaultGroupName() const
{
return defaultGroupName_;
}
} // end namespace Teuchos
#endif // TEUCHOS_STRING_TO_INT_MAP_HPP
|