libopenms-dev 1.11.1-5 / usr / include / OpenMS / MATH / STATISTICS / AveragePosition.h

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Clemens Groepl $
// $Authors: $
// --------------------------------------------------------------------------

#ifndef OPENMS_MATH_STATISTICS_AVERAGEPOSITION_H
#define OPENMS_MATH_STATISTICS_AVERAGEPOSITION_H

#include <OpenMS/DATASTRUCTURES/DPosition.h>

namespace OpenMS
{

  namespace Math
  {
    /**
         @brief Maintain an average position by summing up positions with
         weights.

         @improvement A lot of convenience methods could be added.  For example,
         we could overload operator + and -, consequently +=, -=, even < and ==,
         inherit the whole thing from an extended DPosition with similar
         methods, initialize from iterator ranges, ... but there are not
         concrete use cases at the moment.  Please contact the maintainer if you
         need something for your application field. (Clemens)
    */
    template <UInt D>
    class AveragePosition
    {
public:

      /// Dimensionality
      enum
      {
        DIMENSION = D
      };

      /// Position type (a D-dimensional position)
      typedef DPosition<DIMENSION> PositionType;

      /// Weight type (for weighted average - a scalar type)
      typedef typename PositionType::CoordinateType CoordinateType;

public:

      /// Default constructor
      AveragePosition() :
        position_(),
        position_weighted_sum_(),
        weight_sum_()
      {
      }

      /// Copy constructor
      AveragePosition(AveragePosition const & rhs) :
        position_(rhs.position_),
        position_weighted_sum_(rhs.position_weighted_sum_),
        weight_sum_(rhs.weight_sum_)
      {
      }

      /// Returns the current average position.
      PositionType const & getPosition() const
      {
        return position_;
      }

      /// Returns the total weight.
      CoordinateType const & getWeight() const
      {
        return weight_sum_;
      }

      /// Reset everything.  (Note that \c update() will cause a division by zero after that.)
      void clear()
      {
        position_.clear();
        position_weighted_sum_.clear();
        weight_sum_ = 0;
        return;
      }

      /// Add a position.
      void add(PositionType position, CoordinateType const weight = 1)
      {

        weight_sum_ += weight;
        position *= weight;
        position_weighted_sum_ += position;

        // if the sum of weights is 0, set all coordinates to zero as well
        if (weight_sum_ == 0)
        {
          position_.clear();
        }
        else
        {
          position_ = position_weighted_sum_;
          position_ /= weight_sum_;
        }
        return;
      }

protected:

      PositionType position_;
      PositionType position_weighted_sum_;
      CoordinateType weight_sum_;

    };

  }   // namespace Math

} // namespace OpenMS

#endif //  OPENMS_MATH_STATISTICS_AVERAGEPOSITION_H