VTK-m  2.0
AttachmentIdsEqualComparator.h
Go to the documentation of this file.
1 //============================================================================
2 // Copyright (c) Kitware, Inc.
3 // All rights reserved.
4 // See LICENSE.txt for details.
5 //
6 // This software is distributed WITHOUT ANY WARRANTY; without even
7 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
8 // PURPOSE. See the above copyright notice for more information.
9 //============================================================================
10 // Copyright (c) 2018, The Regents of the University of California, through
11 // Lawrence Berkeley National Laboratory (subject to receipt of any required approvals
12 // from the U.S. Dept. of Energy). All rights reserved.
13 //
14 // Redistribution and use in source and binary forms, with or without modification,
15 // are permitted provided that the following conditions are met:
16 //
17 // (1) Redistributions of source code must retain the above copyright notice, this
18 // list of conditions and the following disclaimer.
19 //
20 // (2) Redistributions in binary form must reproduce the above copyright notice,
21 // this list of conditions and the following disclaimer in the documentation
22 // and/or other materials provided with the distribution.
23 //
24 // (3) Neither the name of the University of California, Lawrence Berkeley National
25 // Laboratory, U.S. Dept. of Energy nor the names of its contributors may be
26 // used to endorse or promote products derived from this software without
27 // specific prior written permission.
28 //
29 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
30 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
31 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 // IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
37 // OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
38 // OF THE POSSIBILITY OF SUCH DAMAGE.
39 //
40 //=============================================================================
41 
42 
43 #ifndef vtk_m_worklet_contourtree_distributed_hierarchical_hyper_augmenter_attachment_ids_equal_comparator_h
44 #define vtk_m_worklet_contourtree_distributed_hierarchical_hyper_augmenter_attachment_ids_equal_comparator_h
45 
46 #include <vtkm/cont/ArrayHandle.h>
49 
50 namespace vtkm
51 {
52 namespace worklet
53 {
54 namespace contourtree_distributed
55 {
56 namespace hierarchical_augmenter
57 {
58 
59 
65 {
66 public:
67  using IdArrayPortalType =
69 
70  // constructor
71  VTKM_CONT
73  : GlobalRegularIdsPortal(globalRegularIdsPortal)
74  { // constructor
75  } // constructor
76 
77  // () operator - gets called to do comparison
78  VTKM_EXEC
79  bool operator()(const vtkm::Id& x, const vtkm::Id& y) const
80  { // operator()
81  return (this->GlobalRegularIdsPortal.Get(x) == this->GlobalRegularIdsPortal.Get(y));
82  } // operator()
83 
84 private:
86 }; // AttachmentIdsEqualComparatorImpl
87 
88 
94 {
95 public:
96  // constructor - takes vectors as parameters
97  VTKM_CONT
100  : GlobalRegularIds(globalRegularIds)
101  { // constructor
102  } // constructor
103 
106  vtkm::cont::Token& token) const
107  {
109  }
110 
111 private:
113 }; // AttachmentIdsEqualComparator
114 
115 } // namespace hierarchical_augmenter
116 } // namespace contourtree_distributed
117 } // namespace worklet
118 } // namespace vtkm
119 
120 #endif
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparator::AttachmentIdsEqualComparator
VTKM_CONT AttachmentIdsEqualComparator(const vtkm::worklet::contourtree_augmented::IdArrayType globalRegularIds)
Definition: AttachmentIdsEqualComparator.h:98
vtkm::cont::ArrayHandle< vtkm::Id >
ArrayHandle.h
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkm::cont::ArrayHandle::PrepareForInput
VTKM_CONT ReadPortalType PrepareForInput(vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
Prepares this array to be used as an input to an operation in the execution environment.
Definition: ArrayHandle.h:574
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparatorImpl::AttachmentIdsEqualComparatorImpl
VTKM_CONT AttachmentIdsEqualComparatorImpl(IdArrayPortalType globalRegularIdsPortal)
Definition: AttachmentIdsEqualComparator.h:72
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparator::GlobalRegularIds
vtkm::worklet::contourtree_augmented::IdArrayType GlobalRegularIds
Definition: AttachmentIdsEqualComparator.h:112
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparatorImpl
Implementation for a comparator that sorts supernode pairs by:
Definition: AttachmentIdsEqualComparator.h:64
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparator
Execution object for a comparator that sorts supernode pairs by:
Definition: AttachmentIdsEqualComparator.h:93
vtkm::cont::ArrayHandle< vtkm::Id >::ReadPortalType
typename StorageType::ReadPortalType ReadPortalType
Definition: ArrayHandle.h:294
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::cont::Token
A token to hold the scope of an ArrayHandle or other object.
Definition: Token.h:35
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparatorImpl::operator()
VTKM_EXEC bool operator()(const vtkm::Id &x, const vtkm::Id &y) const
Definition: AttachmentIdsEqualComparator.h:79
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparatorImpl::GlobalRegularIdsPortal
IdArrayPortalType GlobalRegularIdsPortal
Definition: AttachmentIdsEqualComparator.h:85
Types.h
VTKM_CONT
#define VTKM_CONT
Definition: ExportMacros.h:57
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparatorImpl::IdArrayPortalType
typename vtkm::worklet::contourtree_augmented::IdArrayType::ReadPortalType IdArrayPortalType
Definition: AttachmentIdsEqualComparator.h:68
vtkm::cont::ExecutionObjectBase
Base ExecutionObjectBase for execution objects to inherit from so that you can use an arbitrary objec...
Definition: ExecutionObjectBase.h:31
vtkm::cont::DeviceAdapterId
Definition: DeviceAdapterTag.h:52
ExecutionObjectBase.h
vtkm::worklet::contourtree_distributed::hierarchical_augmenter::AttachmentIdsEqualComparator::PrepareForExecution
VTKM_CONT AttachmentIdsEqualComparatorImpl PrepareForExecution(vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const
Create a AttachmentIdsEqualComparatorImpl object for use in the sort or worklet.
Definition: AttachmentIdsEqualComparator.h:105