gz/math/RollingMean.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_MATH_ROLLINGMEAN_HH_
#define GZ_MATH_ROLLINGMEAN_HH_
 
#include <gz/math/Export.hh>
#include <gz/math/config.hh>
#include <gz/utils/ImplPtr.hh>
 
namespace gz::math
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MATH_VERSION_NAMESPACE {
  class GZ_MATH_VISIBLE RollingMean
  {
    public: explicit RollingMean(size_t _windowSize = 10);
 
    public: double Mean() const;
 
    public: size_t Count() const;
 
    public: void Push(double _value);
 
    public: void Clear();
 
    public: void SetWindowSize(size_t _windowSize);
 
    public: size_t WindowSize() const;
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
  }  // namespace GZ_MATH_VERSION_NAMESPACE
}  // namespace gz::math
#endif  // GZ_MATH_ROLLINGMEAN_HH_