mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
0753131a04
While making changes to how execution objects work, we had agreed to name the base object ExecutionObjectBase instead of its original name of ExecutionObjectFactoryBase. Somehow that change did not make it through.
97 lines
3.0 KiB
C++
97 lines
3.0 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 2015 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
|
// Copyright 2015 UT-Battelle, LLC.
|
|
// Copyright 2015 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-NA0003525 with NTESS,
|
|
// the U.S. Government retains certain rights in this software.
|
|
//
|
|
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
|
|
// Laboratory (LANL), the U.S. Government retains certain rights in
|
|
// this software.
|
|
//============================================================================
|
|
#ifndef vtk_m_exec_AtomicArray_h
|
|
#define vtk_m_exec_AtomicArray_h
|
|
|
|
#include <vtkm/ListTag.h>
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/DeviceAdapter.h>
|
|
#include <vtkm/cont/ExecutionObjectBase.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace exec
|
|
{
|
|
|
|
/// \brief A type list containing types that can be used with an AtomicArray.
|
|
///
|
|
struct AtomicArrayTypeListTag : vtkm::ListTagBase<vtkm::Int32, vtkm::Int64>
|
|
{
|
|
};
|
|
|
|
/// A class that can be used to atomically operate on an array of values safely
|
|
/// across multiple instances of the same worklet. This is useful when you have
|
|
/// an algorithm that needs to accumulate values in parallel, but writing out a
|
|
/// value per worklet might be memory prohibitive.
|
|
///
|
|
/// To construct an AtomicArray you will need to pass in an
|
|
/// vtkm::cont::ArrayHandle that is used as the underlying storage for the
|
|
/// AtomicArray
|
|
///
|
|
/// Supported Operations: add / compare and swap (CAS)
|
|
///
|
|
/// Supported Types: 32 / 64 bit signed integers
|
|
///
|
|
///
|
|
template <typename T, typename DeviceAdapterTag>
|
|
class AtomicArray : public vtkm::cont::ExecutionObjectBase
|
|
{
|
|
public:
|
|
using ValueType = T;
|
|
|
|
VTKM_CONT
|
|
AtomicArray()
|
|
: AtomicImplementation((vtkm::cont::ArrayHandle<T>()))
|
|
{
|
|
}
|
|
|
|
template <typename StorageType>
|
|
VTKM_CONT AtomicArray(vtkm::cont::ArrayHandle<T, StorageType> handle)
|
|
: AtomicImplementation(handle)
|
|
{
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC
|
|
T Add(vtkm::Id index, const T& value) const
|
|
{
|
|
return this->AtomicImplementation.Add(index, value);
|
|
}
|
|
|
|
//
|
|
// Compare and Swap is an atomic exchange operation. If the value at
|
|
// the index is equal to oldValue, then newValue is written to the index.
|
|
// The operation was successful if return value is equal to oldValue
|
|
//
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC
|
|
T CompareAndSwap(vtkm::Id index, const T& newValue, const T& oldValue) const
|
|
{
|
|
return this->AtomicImplementation.CompareAndSwap(index, newValue, oldValue);
|
|
}
|
|
|
|
private:
|
|
vtkm::cont::DeviceAdapterAtomicArrayImplementation<T, DeviceAdapterTag> AtomicImplementation;
|
|
};
|
|
}
|
|
} // namespace vtkm::exec
|
|
|
|
#endif //vtk_m_exec_AtomicArray_h
|