update docs for fully integrating utils::bounds_typlabel() function

This commit is contained in:
Axel Kohlmeyer
2024-06-25 18:23:07 -04:00
parent 5cbe85ecf1
commit 8e4ffdc84e
2 changed files with 24 additions and 8 deletions

View File

@ -211,6 +211,9 @@ Argument processing
.. doxygenfunction:: bounds
:project: progguide
.. doxygenfunction:: bounds_typelabel
:project: progguide
.. doxygenfunction:: expand_args
:project: progguide

View File

@ -331,12 +331,25 @@ namespace utils {
void bounds(const char *file, int line, const std::string &str, bigint nmin, bigint nmax,
TYPE &nlo, TYPE &nhi, Error *error);
/*! Same as bounds(), but supports type labels
*
* This functions adds the following case:
*
* - a single type label, typestr: nlo = nhi = label2type(typestr)
/*! Same as bounds(), but supports type labels in addition
*
\verbatim embed:rst
.. versionadded:: 27June2024
This functions adds the following case to :cpp:func:`utils::bounds() <LAMMPS_NS::utils::bounds>`:
- a single type label, typestr: nlo = nhi = label2type(typestr)
\endverbatim
* \param file name of source file for error message
* \param line line number in source file for error message
* \param str string to be processed
* \param nmin smallest possible lower bound
* \param nmax largest allowed upper bound
* \param nlo lower bound
* \param nhi upper bound
* \param lmp pointer to top-level LAMMPS class instance
* \param mode select labelmap using constants from Atom class */
@ -418,8 +431,8 @@ namespace utils {
* \return index which column of data is referenced (0 for vec, 1-N for array)
* \return ArgINFO::COMPUTE or FIX or UNKNOWN or NONE */
int check_grid_reference(char *errstr, char *ref, int nevery,
char *&id, int &igrid, int &idata, int &index, LAMMPS *lmp);
int check_grid_reference(char *errstr, char *ref, int nevery, char *&id, int &igrid, int &idata,
int &index, LAMMPS *lmp);
/*! Parse grid reference into 3 sub-strings
*
@ -501,7 +514,7 @@ or the *-suffix/-sf* command line flag and return correspondingly modified strin
std::string strip_style_suffix(const std::string &style, LAMMPS *lmp);
/*! Check if a string will likely have UTF-8 encoded characters
/*! Check if a string will likely have UTF-8 encoded characters
*
* UTF-8 uses the 7-bit standard ASCII table for the first 127 characters and
* all other characters are encoded as multiple bytes. For the multi-byte