Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
KiT-RT
KiT-RT
Commits
cf127ebb
Commit
cf127ebb
authored
Feb 28, 2021
by
jannick.wolters
Browse files
removed [in/out] doc tags
parent
5feed9eb
Pipeline
#138231
passed with stage
in 18 minutes and 30 seconds
Changes
2
Pipelines
2
Hide whitespace changes
Inline
Side-by-side
code/include/common/config.h
View file @
cf127ebb
...
...
@@ -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
);
...
...
code/include/toolboxes/interpolation.h
View file @
cf127ebb
...
...
@@ -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
;
};
...
...
jannick.wolters
@jm2154
mentioned in commit
9347ea1e
·
Apr 30, 2021
mentioned in commit
9347ea1e
mentioned in commit 9347ea1e8ec8791d78b67c0c627c139db51dd9a9
Toggle commit list
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment