test_common.hpp

Go to the documentation of this file.

/*! \file
 *
 * \brief Miscellaneous testing functions
 */

#pragma once

#include <string>
#include <vector>
#include <istream>
#include <limits>

namespace mirp {

//! \brief  Maximum length of a line
static const std::streamsize max_length = std::numeric_limits<std::streamsize>::max();


/*! \brief Print the results of a test
 *
 * \param [in] nfailed Number of failed tests
 * \param [in] ntests Total number of tests run
 */
void print_results(unsigned long nfailed, unsigned long ntests);


/*! \brief Convert a character representing an angular momentum to an integer
 *
 * Converts s,p,d,f,... to 0,1,2,3,...
 *
 * The character is case insensitive
 *
 * \throw std::runtime_error if the character cannot be converted to an integer
 */
int amchar_to_int(char am);


/*! \brief Convert a string representing an element to its atomic Z number
 *
 * Converts H to 1, He to 2, etc
 *
 * The element string is case insensitive
 *
 * \throw std::runtime_error if the character cannot be converted to an integer
 */
int element_to_z(const std::string & element);


/*! \brief Converts a string to lower case, returning a copy */
std::string str_tolower(const std::string & s);


/*! \brief Trims spaces and tabs from both ends of a string, returning a copy */
std::string trim(const std::string & s);


/*! \brief Splits a string into components
 *
 * The components must be separated by the character \p sep
 */
std::vector<std::string> split(const std::string & s, char sep = ' ');


/*! \brief Advances the stream past any comment and blank lines
 *
 * The stream will be advanced past the lines that were read.
 *
 * If an EOF is encountered, false is returned
 *
 * \param [in] fs The stream to read from
 * \param [in] commentchar Lines beginning with the character will be skipped
 * \return True if there is additional data in the file, false on EOF
 */
bool file_skip(std::istream & fs, char commentchar);

} // close namespace mirp