//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
// Copyright (c) 2018, The Regents of the University of California, through
// Lawrence Berkeley National Laboratory (subject to receipt of any required approvals
// from the U.S. Dept. of Energy).  All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright notice, this
//     list of conditions and the following disclaimer.
//
// (2) 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.
//
// (3) Neither the name of the University of California, Lawrence Berkeley National
//     Laboratory, U.S. Dept. of Energy nor the names of its contributors may be
//     used to endorse or promote products derived from this software without
//     specific prior written permission.
//
// 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
//
//=============================================================================
//
//  This code is an extension of the algorithm presented in the paper:
//  Parallel Peak Pruning for Scalable SMP Contour Tree Computation.
//  Hamish Carr, Gunther Weber, Christopher Sewell, and James Ahrens.
//  Proceedings of the IEEE Symposium on Large Data Analysis and Visualization
//  (LDAV), October 2016, Baltimore, Maryland.
//
//  The PPP2 algorithm and software were jointly developed by
//  Hamish Carr (University of Leeds), Gunther H. Weber (LBNL), and
//  Oliver Ruebel (LBNL)
//==============================================================================

#ifndef vtk_m_worklet_contourtree_distributed_bract_maker_propagate_boundary_counts_transfer_dependent_counts_worklet_h
#define vtk_m_worklet_contourtree_distributed_bract_maker_propagate_boundary_counts_transfer_dependent_counts_worklet_h

#include <vtkm/worklet/WorkletMapField.h>
#include <vtkm/worklet/contourtree_augmented/Types.h>

namespace vtkm
{
namespace worklet
{
namespace contourtree_distributed
{
namespace bract_maker
{

/// Worklet to transfer the dependent counts for hyperarcs
/// Part of the BoundaryRestrictedAugmentedContourTree.PropagateBoundaryCounts function
class PropagateBoundaryCountsTransferDependentCountsWorklet : public vtkm::worklet::WorkletMapField
{
public:
  using ControlSignature = void(FieldIn supernodeIndex, // (input) index of supernodes for iteration
                                WholeArrayIn hypernodes, // (input) contour tree hypernodes
                                WholeArrayIn superarcDependentBoundaryCount, // (input)
                                WholeArrayOut hyperarcDependentBoundaryCount // (output)
  );
  using ExecutionSignature = void(_1, _2, _3, _4);
  using InputDomain = _1;

  // Default Constructor
  VTKM_EXEC_CONT
  PropagateBoundaryCountsTransferDependentCountsWorklet(vtkm::Id numSupernodes,
                                                        vtkm::Id numHypernodes)
    : NumSupernodes(numSupernodes)
    , NumHypernodes(numHypernodes)
  {
  }

  template <typename InFieldPortalType, typename OutFieldPortalType>
  VTKM_EXEC void operator()(const vtkm::Id& hypernode,
                            const InFieldPortalType& hypernodesPortal,
                            const InFieldPortalType& superarcDependentBoundaryCountPortal,
                            const OutFieldPortalType& hyperarcDependentBoundaryCountPortal) const
  {
    // v. per hypernode
    // A.Transfer dependent count from last superarc to hyperarc
    // Last superarc for the hyperarc
    vtkm::Id lastSuperarc;
    // special case for the last hyperarc
    if (hypernode == this->NumHypernodes - 1)
    {
      lastSuperarc = this->NumSupernodes - 1;
    }
    else
    {
      lastSuperarc =
        vtkm::worklet::contourtree_augmented::MaskedIndex(hypernodesPortal.Get(hypernode + 1)) - 1;
    }
    // 	Transfer the dependent count
    hyperarcDependentBoundaryCountPortal.Set(
      hypernode, superarcDependentBoundaryCountPortal.Get(lastSuperarc));

    // In serial this worklet implements the following operation
    /*
    for (vtkm::Id hypernode = firstHypernode; hypernode < lastHypernode; hypernode++)
    { // v. per hypernode
      //		A.	Transfer dependent count from last superarc to hyperarc
      // 			Last superarc for the hyperarc
      vtkm::Id lastSuperarc;
      // special case for the last hyperarc
      if (hypernode == contourTree->hypernodes.size() - 1)
          lastSuperarc = contourTree->supernodes.size() - 1;
      else
          lastSuperarc = maskedIndex(contourTree->hypernodes[hypernode + 1]) - 1;

      // 			Transfer the dependent count
      hyperarcDependentBoundaryCount[hypernode] = superarcDependentBoundaryCount[lastSuperarc];
    */
  }

private:
  vtkm::Id NumSupernodes;
  vtkm::Id NumHypernodes;

}; // PropagateBoundaryCountsTransferDependentCountsWorklet


} // namespace bract_maker
} // namespace contourtree_distributed
} // namespace worklet
} // namespace vtkm

#endif
