//============================================================================
//  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_tree_grafter_find_critical_points_find_saddles_worklet_h
#define vtk_m_worklet_contourtree_distributed_tree_grafter_find_critical_points_find_saddles_worklet_h


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

namespace vtkm
{
namespace worklet
{
namespace contourtree_distributed
{
namespace tree_grafter
{

// Worklet used in TreeGrafter.FindCriticalPoints to find and flag saddles
class FindCriticalPointsFindSaddlesWorklet : public vtkm::worklet::WorkletMapField
{
public:
  using ControlSignature = void(
    FieldIn
      activeSuperarcs, // input iteration index. loop to one less than ContourTree->Supernodes.GetNumberOfValues()
    WholeArrayIn interiorForstIsNecessary, // input
    WholeArrayIn upNeighbour,              // input
    WholeArrayIn downNeighbour,            // input
    WholeArrayOut supernodeType            // output
  );

  using ExecutionSignature = void(_1, _2, _3, _4, _5);
  using InputDomain = _1;

  // Default Constructor
  VTKM_EXEC_CONT
  FindCriticalPointsFindSaddlesWorklet() {}

  template <typename InFieldPortalType, typename OutFieldPortalType>
  VTKM_EXEC void operator()(const vtkm::worklet::contourtree_augmented::EdgePair& activeSuperarc,
                            const InFieldPortalType& isNecessaryPortal,
                            const InFieldPortalType& upNeighbourPortal,
                            const InFieldPortalType& downNeighbourPortal,
                            const OutFieldPortalType& supernodeTypePortal) const
  { // operator ()
    // per active superarc
    // retrieve the ends again
    vtkm::Id lowEnd = activeSuperarc.first;
    vtkm::Id highEnd = activeSuperarc.second;

    // if the low end doesn't have the high end as the up neighbour, another arc succeeded in writing to it
    // which guarantees that it is a saddle (or an attachment - but we exclude that by testing it)
    if (!isNecessaryPortal.Get(lowEnd) && (upNeighbourPortal.Get(lowEnd) != highEnd))
    {
      supernodeTypePortal.Set(lowEnd, (vtkm::Id)vtkm::worklet::contourtree_augmented::IS_SADDLE);
    }

    // symmetrically for the high end
    if (!isNecessaryPortal.Get(highEnd) && (downNeighbourPortal.Get(highEnd) != lowEnd))
    {
      supernodeTypePortal.Set(highEnd, (vtkm::Id)vtkm::worklet::contourtree_augmented::IS_SADDLE);
    }

    // In serial this worklet implements the following operation
    /*
    // now test whether they match what we expect: if not, we've found a saddle
    for (indexType activeSuper = 0; activeSuper < activeSuperarcs.size(); activeSuper++)
      { // per active superarc
      // retrieve the ends again
      indexType lowEnd = activeSuperarcs[activeSuper].low;
      indexType highEnd = activeSuperarcs[activeSuper].high;

      // if the low end doesn't have the high end as the up neighbour, another arc succeeded in writing to it
      // which guarantees that it is a saddle (or an attachment - but we exclude that by testing it)
      if (!residue->isNecessary[lowEnd] && (upNeighbour[lowEnd] != highEnd))
        supernodeType[lowEnd] = IS_SADDLE;

      // symmetrically for the high end
      if (!residue->isNecessary[highEnd] && (downNeighbour[highEnd] != lowEnd))
        supernodeType[highEnd] = IS_SADDLE;
      } // per active superarc
    */
  } // operator ()

}; // FindCriticalPointsFindSaddlesWorklet

} // namespace tree_grafter
} // namespace contourtree_distributed
} // namespace worklet
} // namespace vtkm

#endif
