Gazebo Math

API Reference

7.4.0
gz/math/RollingMean.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2019 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16*/
17#ifndef GZ_MATH_ROLLINGMEAN_HH_
18#define GZ_MATH_ROLLINGMEAN_HH_
19
20#include <gz/math/Export.hh>
21#include <gz/math/config.hh>
22#include <gz/utils/ImplPtr.hh>
23
24namespace gz
25{
26 namespace math
27 {
28 // Inline bracket to help doxygen filtering.
29 inline namespace GZ_MATH_VERSION_NAMESPACE {
34 class GZ_MATH_VISIBLE RollingMean
35 {
39 public: explicit RollingMean(size_t _windowSize = 10);
40
45 public: double Mean() const;
46
49 public: size_t Count() const;
50
53 public: void Push(double _value);
54
56 public: void Clear();
57
61 public: void SetWindowSize(size_t _windowSize);
62
65 public: size_t WindowSize() const;
66
68 GZ_UTILS_IMPL_PTR(dataPtr)
69 };
70 }
71 }
72}
73
74#endif