vtk-m2/vtkm/worklet/contourtree_distributed/tree_grafter/HyperNodeWhenComparator.h
2020-12-02 14:29:11 -08:00

143 lines
5.2 KiB
C++

//============================================================================
// 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_hypernode_when_comparator_h
#define vtk_m_worklet_contourtree_distributed_tree_grafter_hypernode_when_comparator_h
#include <vtkm/cont/ExecutionObjectBase.h>
#include <vtkm/worklet/contourtree_augmented/Types.h>
namespace vtkm
{
namespace worklet
{
namespace contourtree_distributed
{
namespace tree_grafter
{
/// Comparator used in TreeGrafter::ListNewHypernodes to sort the NewHypernodes arrays
template <typename DeviceAdapter>
class HyperNodeWhenComparatorImpl : public vtkm::worklet::WorkletMapField
{
public:
using IdArrayPortalType =
typename vtkm::worklet::contourtree_augmented::IdArrayType::template ExecutionTypes<
DeviceAdapter>::PortalConst;
// Default Constructor
VTKM_EXEC_CONT
HyperNodeWhenComparatorImpl(const IdArrayPortalType& whenTransferredPortal)
: WhenTransferredPortal(whenTransferredPortal)
{
}
VTKM_EXEC bool operator()(const vtkm::Id& leftSuperId, const vtkm::Id& rightSuperId) const
{ // operator ()
vtkm::Id maskedLeftWhen = vtkm::worklet::contourtree_augmented::MaskedIndex(
this->WhenTransferredPortal.Get(leftSuperId));
vtkm::Id maskedRightWhen = vtkm::worklet::contourtree_augmented::MaskedIndex(
this->WhenTransferredPortal.Get(rightSuperId));
if (maskedLeftWhen < maskedRightWhen)
{
return true;
}
else if (maskedLeftWhen > maskedRightWhen)
{
return false;
}
// tie break on ID to make it canonical
else
{
return (leftSuperId < rightSuperId);
}
} // operator ()
private:
IdArrayPortalType WhenTransferredPortal;
}; // HyperNodeWhenComparator
class HyperNodeWhenComparator : public vtkm::cont::ExecutionObjectBase
{
public:
VTKM_CONT
HyperNodeWhenComparator(const vtkm::worklet::contourtree_augmented::IdArrayType& whenTransferred)
: WhenTransferred(whenTransferred)
{
}
template <typename DeviceAdapter>
VTKM_CONT HyperNodeWhenComparatorImpl<DeviceAdapter> PrepareForExecution(
DeviceAdapter device,
vtkm::cont::Token& token) const
{
return HyperNodeWhenComparatorImpl<DeviceAdapter>(
this->WhenTransferred.PrepareForInput(device, token));
}
private:
const vtkm::worklet::contourtree_augmented::IdArrayType& WhenTransferred;
};
} // namespace tree_grafter
} // namespace contourtree_distributed
} // namespace worklet
} // namespace vtkm
#endif