Fawkes API Fawkes Development Version
interpolator.cpp
1
2/***************************************************************************
3 * interpolator.cpp - Interpolator
4 *
5 * Created: Tue Nov 18 10:45:18 2008
6 * Copyright 2008 Tim Niemueller [www.niemueller.de]
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version. A runtime exception applies to
14 * this software (see LICENSE.GPL_WRE file mentioned below for details).
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Library General Public License for more details.
20 *
21 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22 */
23
24#include <utils/math/interpolation/interpolator.h>
25
26namespace fawkes {
27
28/** @class Interpolator <utils/math/interpolation/interpolator.h>
29 * Value interpolator.
30 * The interpolator creates intermediate points given a starting and and
31 * end point and time constraints. Times are supplied any chose time scale, it
32 * only has to be a linear time measure. Common are miliseconds or seconds.
33 * @author Tim Niemueller
34 *
35 * @fn float Interpolator::interpolate(float t_current, float t_end, float t_step, float v_start, float v_end)
36 * Interpolate a point at a specific time.
37 * @param t_current current time for which to calculate the intermediate point
38 * @param t_end end time/total time. The start time is always 0.
39 * @param t_step Time of a time slice for discrete intermediate interpolation
40 * points. Set to 1 for maximum resolution.
41 * @param v_start start value
42 * @param v_end end value
43 * @return interpolated value at time t_current between t_start and t_end.
44 */
45
46/** Virtual empty descructor. */
48{
49}
50
51} // end namespace fawkes
virtual ~Interpolator()
Virtual empty descructor.
Fawkes library namespace.