Commit 9347ea1e authored by jannick.wolters's avatar jannick.wolters
Browse files

removed [in/out] doc tags


Former-commit-id: cf127ebb
parent 2a245d78
......@@ -163,9 +163,9 @@ class Config
/*!
* @brief breaks an input line from the config file into a set of tokens
* @param[in] str - the input line string
* @param[out] option_name - the name of the option found at the beginning of the line
* @param[out] option_value - the tokens found after the "=" sign on the line
* @param str the input line string
* @param option_name the name of the option found at the beginning of the line
* @param option_value the tokens found after the "=" sign on the line
* @return false if the line is empty or a commment, true otherwise
*/
bool TokenizeString( std::string& str, std::string& option_name, std::vector<std::string>& option_value );
......
......@@ -38,56 +38,56 @@ class Interpolation
// In constructor tabulated values are initialised
/*!
* @brief constructor linear interpolation for std::vector input
* @param[in] x - table values for x
* @param[in] y - table values for y
* @param[in] type - linear or cubic interpolation
* @param x table values for x
* @param y table values for y
* @param type linear or cubic interpolation
*/
Interpolation( const std::vector<double>& x, const std::vector<double>& y, TYPE type = linear );
/*!
* @brief constructor linear interpolation for Vector input
* @param[in] x - table values for x
* @param[in] y - table values for y
* @param[in] type - linear or cubic interpolation
* @param x table values for x
* @param y table values for y
* @param type linear or cubic interpolation
*/
Interpolation( const Vector& x, const Vector& y, TYPE type = linear );
/*!
* @brief constructor cubic interpolation
* @param[in] x table values for x
* @param[in] y table values for y
* @param[in] data matrix w.r.t x y grid
* @param[in] type of interpolation (linear, loglinear, cubic)
* @param x table values for x
* @param y table values for y
* @param data matrix w.r.t x y grid
* @param type of interpolation (linear, loglinear, cubic)
*/
Interpolation( const Vector& x, const Vector& y, const Matrix& data, TYPE type = cubic );
// Here the interpolation between the previously defined table values is performed
/*!
* @brief defines one dimensional interpolation at x
* @param[in] x - value at which to interpolate
* @returns y - corresponding interpolated y value
* @param x value at which to interpolate
* @returns corresponding interpolated y value
*/
double operator()( double x ) const;
/*!
* @brief defines interpolation for a Vector of values
* @param[in] v - values at which to interpolate
* @returns y - corresponding interpolated values
* @param v values at which to interpolate
* @returns corresponding interpolated values
*/
Vector operator()( Vector v ) const;
/*!
* @brief defines interpolation for a std::vector of values
* @param[in] v - values at which to interpolate
* @returns y - corresponding interpolated values
* @param v values at which to interpolate
* @returns corresponding interpolated values
*/
std::vector<double> operator()( std::vector<double> v ) const;
/*!
* @brief defines 2D interpolation at x and y
* @param[in] x - value at which to interpolate
* @param[in] y - value at which to interpolate
* @returns data - corresponding interpolated value
* @param x value at which to interpolate
* @param y value at which to interpolate
* @returns corresponding interpolated value
*/
double operator()( double x, double y ) const;
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment