diff --git a/Documentation/ProjectFile/curve/i_curve.md b/Documentation/ProjectFile/curve/i_curve.md new file mode 100644 index 0000000000000000000000000000000000000000..d84424ab1266feb01476e10dc75daa0f9136bca3 --- /dev/null +++ b/Documentation/ProjectFile/curve/i_curve.md @@ -0,0 +1,5 @@ +Defines a single curve. + +The curve is given by a set of coordinates (the arguments) and a set of values +at these coordinates. The values for any arguments between the given coordinates +are obtained via linear interpolation. diff --git a/Documentation/ProjectFile/curve/t_coords.md b/Documentation/ProjectFile/curve/t_coords.md new file mode 100644 index 0000000000000000000000000000000000000000..933b7b48afcd51740ce9324835641b91fdd6c717 --- /dev/null +++ b/Documentation/ProjectFile/curve/t_coords.md @@ -0,0 +1 @@ +Coordinates at which the curve's values are given. diff --git a/Documentation/ProjectFile/curve/t_values.md b/Documentation/ProjectFile/curve/t_values.md new file mode 100644 index 0000000000000000000000000000000000000000..54414177453746b1d81227d7f3d9d317c393fb3b --- /dev/null +++ b/Documentation/ProjectFile/curve/t_values.md @@ -0,0 +1 @@ +Values of the curve at the given coordinates. diff --git a/MathLib/Curve/CreatePiecewiseLinearCurve.h b/MathLib/Curve/CreatePiecewiseLinearCurve.h index 9ad5273c3f3ab7cc6f1ce88efc27ae4ea4df9b7a..1dbcccbf84a674bd15550c5770a6375074fe06a8 100644 --- a/MathLib/Curve/CreatePiecewiseLinearCurve.h +++ b/MathLib/Curve/CreatePiecewiseLinearCurve.h @@ -23,7 +23,7 @@ class ConfigTree; namespace MathLib { /// Create a curve -/// \param config ConfigTree object has a tag of '<curve>' +/// \param config ConfigTree object has a tag of `<curve>` template <typename CurveType> std::unique_ptr<CurveType> createPiecewiseLinearCurve( BaseLib::ConfigTree const& config);