ITK  4.3.0
Insight Segmentation and Registration Toolkit
itkCompensatedSummation.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef __itkCompensatedSummation_h
19 #define __itkCompensatedSummation_h
20 
21 #include "itkNumericTraits.h"
22 #include "itkConceptChecking.h"
23 
24 namespace itk
25 {
26 
65 template < class TFloat >
67 {
68 public:
70  typedef TFloat FloatType;
71 
74 
77 
80 
82  CompensatedSummation( const Self & rhs );
83 
85  void operator=( const Self & rhs );
86 
88  void AddElement( const FloatType & element );
89  Self & operator+=( const FloatType & rhs );
91 
93  Self & operator-=( const FloatType & rhs );
94 
97  Self & operator*=( const FloatType & rhs );
98  Self & operator/=( const FloatType & rhs );
100 
102  void ResetToZero();
103 
105  Self & operator=( const FloatType & rhs );
106 
108  const AccumulateType & GetSum() const;
109 
110 private:
113 
114 // Maybe support more types in the future with template specialization.
115 #ifdef ITK_USE_CONCEPT_CHECKING
116  itkConceptMacro( OnlyDefinedForFloatingPointTypes, ( itk::Concept::IsFloatingPoint< TFloat > ) );
117 #endif // ITK_USE_CONCEPT_CHECKING
118 };
119 
120 void ITKCommon_EXPORT CompensatedSummationAddElement( float& compensation, float& sum, const float& element );
121 void ITKCommon_EXPORT CompensatedSummationAddElement( double& compensation, double& sum, const double& element );
122 
123 } // end namespace itk
124 
125 #ifndef ITK_MANUAL_INSTANTIATION
126 #include "itkCompensatedSummation.hxx"
127 #endif
128 
129 #endif
130