itkCompensatedSummation.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.txt
 *
 *  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 itkCompensatedSummation_h
#define itkCompensatedSummation_h

#include "itkNumericTraits.h"
#include "itkConceptChecking.h"

namespace itk
{

template < typename TFloat >
class ITK_TEMPLATE_EXPORT CompensatedSummation
{
public:
  using FloatType = TFloat;

  using AccumulateType = typename NumericTraits< FloatType >::AccumulateType;

  using Self = CompensatedSummation;

  CompensatedSummation();
  CompensatedSummation(FloatType value);

  CompensatedSummation( const Self & rhs );

  Self & operator=( const Self & rhs );

  void AddElement( const FloatType & element );
  Self & operator+=( const FloatType & rhs );
  Self & operator+=( const Self & rhs );

  Self & operator-=( const FloatType & rhs );

  Self & operator*=( const FloatType & rhs );
  Self & operator/=( const FloatType & rhs );

  void ResetToZero();

  Self & operator=( const FloatType & rhs );

  const AccumulateType & GetSum() const;

  explicit operator FloatType() const;

private:
  AccumulateType m_Sum;
  AccumulateType m_Compensation;

// Maybe support more types in the future with template specialization.
#ifdef ITK_USE_CONCEPT_CHECKING
  itkConceptMacro( OnlyDefinedForFloatingPointTypes, ( itk::Concept::IsFloatingPoint< TFloat > ) );
#endif // ITK_USE_CONCEPT_CHECKING
};

void ITKCommon_EXPORT CompensatedSummationAddElement( float& compensation, float& sum, const float& element );
void ITKCommon_EXPORT CompensatedSummationAddElement( double& compensation, double& sum, const double& element );

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkCompensatedSummation.hxx"
#endif

#endif