//============================================================================
//  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_find_superarc_between_nodes_h
#define vtk_m_worklet_contourtree_distributed_find_superarc_between_nodes_h

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


namespace vtkm
{
namespace worklet
{
namespace contourtree_distributed
{


/// Device implementation of FindSuperArcBetweenNodes for the HierarchicalContourTree
/// Used in the hierarchical branch decomposition
class FindSuperArcBetweenNodesDeviceData
{
public:
  using IndicesPortalType =
    typename vtkm::worklet::contourtree_augmented::IdArrayType::ReadPortalType;

  VTKM_CONT
  FindSuperArcBetweenNodesDeviceData(
    vtkm::cont::DeviceAdapterId device,
    vtkm::cont::Token& token,
    const vtkm::worklet::contourtree_augmented::IdArrayType& superarcs)
  {
    // Prepare the arrays for input and store the array portals
    // so that they can be used inside a workelt
    this->SuperarcsPortal = superarcs.PrepareForInput(device, token);
  }

  // routine to find the superarc from one node to another
  // it will always be the same ID as one of them if it exists
  // if not, it will be NO_SUCH_ELEMENT
  VTKM_EXEC
  vtkm::Id FindSuperArcBetweenNodes(vtkm::Id firstSupernode, vtkm::Id secondSupernode) const
  { // FindSuperArcBetweenNodes()
    // if the second is the target of the first's superarc
    if (vtkm::worklet::contourtree_augmented::MaskedIndex(
          this->SuperarcsPortal.Get(firstSupernode)) == secondSupernode)
    {
      return firstSupernode;
    }
    // flip and test the other way
    if (vtkm::worklet::contourtree_augmented::MaskedIndex(
          this->SuperarcsPortal.Get(secondSupernode)) == firstSupernode)
    {
      return secondSupernode;
    }
    // otherwise it fails
    return vtkm::worklet::contourtree_augmented::NO_SUCH_ELEMENT;
  } // FindSuperArcBetweenNodes()

private:
  // Array portals needed by FindSuperArcBetweenNodes
  IndicesPortalType SuperarcsPortal;
};


/// ExecutionObject to generate a device object to use FindSuperArcBetweenNodes for the HierarchicalContourTree
class FindSuperArcBetweenNodes : public vtkm::cont::ExecutionObjectBase
{
public:
  /// constructor
  VTKM_CONT
  FindSuperArcBetweenNodes(const vtkm::worklet::contourtree_augmented::IdArrayType& superarcs)
    : Superarcs(superarcs)
  {
  }

  VTKM_CONT FindSuperArcBetweenNodesDeviceData
  PrepareForExecution(vtkm::cont::DeviceAdapterId device, vtkm::cont::Token& token) const
  {
    return FindSuperArcBetweenNodesDeviceData(device, token, this->Superarcs);
  }

private:
  // Array portals needed by FindSuperArcBetweenNodes
  vtkm::worklet::contourtree_augmented::IdArrayType Superarcs;
};


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

#endif
