/*=========================================================================
 *
 *  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 itkImageHelper_h
#define itkImageHelper_h

#include "itkConceptChecking.h"

namespace itk
{
/** \class ImageHelper
 *  \brief Fast Index/Offset computation
 *
 * These helper methods use recursive templates to unroll the loops
 * of simple calculations. The resulting speed improvement varies from
 * compiler to compiler. Some gcc compilers with debug turned on
 * exhibit slight speed increases, but most compilers see
 * improvement. The ComputeOffset performance improvement is
 * impressive. For example, the Windows VS7.0 compiler shows almost a
 * factor of 2 speed improvement with the recursive templates. Usually
 * recursive templates use partial specialization to terminate
 * loops. Here we use a technique used by Brad King in the itk Concept
 * Checking code.
 *
 * \note This work is part of the National Alliance for Medical Image
 * Computing (NAMIC), funded by the National Institutes of Health
 * through the NIH Roadmap for Medical Research, Grant U54 EB005149.
 * Information on the National Centers for Biomedical Computing
 * can be obtained from http://commonfund.nih.gov/bioinformatics.
 *
 * \ingroup ITKCommon
 */

// Forward reference because of circular dependencies
template<
  unsigned int NImageDimension
  >
class ITK_TEMPLATE_EXPORT ImageBase;

template< unsigned int NImageDimension, unsigned int NLoop >
class ImageHelper
{
public:
  typedef ImageBase< NImageDimension >              ImageType;
  typedef typename ImageType::IndexType             IndexType;
  typedef typename ImageType::OffsetType            OffsetType;
  typedef typename ImageType::OffsetValueType       OffsetValueType;
  typedef typename ImageType::IndexValueType        IndexValueType;
  typedef Concept::Detail::UniqueType_bool< false > UniqueTypeBoolFalse;
  typedef Concept::Detail::UniqueType_bool< true >  UniqueTypeBoolTrue;

  /** ComputeIndex with recursive templates */
  inline static void ComputeIndex(const IndexType & bufferedRegionIndex,
                                  OffsetValueType offset,
                                  const OffsetValueType offsetTable[],
                                  IndexType & index)
  {
    ImageHelper< NImageDimension, NLoop - 1 >::
    ComputeIndexInner( bufferedRegionIndex,
                       offset,
                       offsetTable,
                       index,
                       Concept::Detail::UniqueType_bool< ( NLoop == 1 ) >() );
  }

  inline static void ComputeIndexInner(const IndexType & bufferedRegionIndex,
                                       OffsetValueType & offset,
                                       const OffsetValueType offsetTable[],
                                       IndexType & index,
                                       const UniqueTypeBoolFalse &)
  {
    index[NLoop] = static_cast< IndexValueType >( offset / offsetTable[NLoop] );
    offset = offset - ( index[NLoop] * offsetTable[NLoop] );
    index[NLoop] = index[NLoop] + bufferedRegionIndex[NLoop];
    ImageHelper< NImageDimension, NLoop - 1 >::
    ComputeIndexInner( bufferedRegionIndex,
                       offset,
                       offsetTable,
                       index,
                       Concept::Detail::UniqueType_bool< ( NLoop == 1 ) >() );
  }

  inline static void ComputeIndexInner(const IndexType & bufferedRegionIndex,
                                       OffsetValueType & offset,
                                       const OffsetValueType[],
                                       IndexType & index,
                                       const UniqueTypeBoolTrue &)
  {
    // Do last
    index[0] = bufferedRegionIndex[0] + static_cast< IndexValueType >( offset );
  }

  // ComputeOffset
  //
  inline static void ComputeOffset(const IndexType & bufferedRegionIndex,
                                   const IndexType & index,
                                   const OffsetValueType offsetTable[],
                                   OffsetValueType & offset)
  {
    ImageHelper< NImageDimension, NLoop - 1 >::
    ComputeOffsetInner( bufferedRegionIndex,
                        index,
                        offsetTable,
                        offset,
                        Concept::Detail::UniqueType_bool< ( NLoop == 1 ) >() );
  }

  inline static void ComputeOffsetInner(const IndexType & bufferedRegionIndex,
                                        const IndexType & index,
                                        const OffsetValueType offsetTable[],
                                        OffsetValueType & offset,
                                        const UniqueTypeBoolFalse &)
  {
    offset = offset + ( index[NLoop] - bufferedRegionIndex[NLoop] ) * offsetTable[NLoop];
    ImageHelper< NImageDimension, NLoop - 1 >::
    ComputeOffsetInner( bufferedRegionIndex,
                        index,
                        offsetTable,
                        offset,
                        Concept::Detail::UniqueType_bool< ( NLoop == 1 ) >() );
  }

  inline static void ComputeOffsetInner(const IndexType & bufferedRegionIndex,
                                        const IndexType & index,
                                        const OffsetValueType[],
                                        OffsetValueType & offset,
                                        const UniqueTypeBoolTrue &)
  {
    // Do last
    offset = offset + index[0] - bufferedRegionIndex[0];
  }
};
} // end namespace itk

#endif