ArrayHandleRandomUniformBits.h

Go to the documentation of this file.

//============================================================================
//  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.
//============================================================================
#ifndef vtk_m_cont_ArrayHandleRandomUniformBits_h
#define vtk_m_cont_ArrayHandleRandomUniformBits_h
 
#include <random>
#include <vtkm/cont/ArrayHandleImplicit.h>
#include <vtkm/random/Philox.h>
 
namespace vtkm
{
namespace cont
{
 
namespace detail
{
struct PhiloxFunctor
{
  using SeedType = vtkm::Vec<vtkm::UInt32, 1>;
 
  PhiloxFunctor() = default;
 
  explicit PhiloxFunctor(SeedType seed)
    : Seed(seed)
  {
  }
 
  VTKM_EXEC_CONT
  vtkm::UInt64 operator()(vtkm::Id index) const
  {
    using philox_functor = vtkm::random::PhiloxFunctor2x32x10;
    using counters_type = typename philox_functor::counters_type;
 
    auto idx = static_cast<vtkm::UInt64>(index);
    counters_type counters{ static_cast<vtkm::UInt32>(idx), static_cast<vtkm::UInt32>(idx >> 32) };
    counters_type result = philox_functor{}(counters, Seed);
    return static_cast<vtkm::UInt64>(result[0]) | static_cast<vtkm::UInt64>(result[1]) << 32;
  }
 
private:
  // This is logically a const, however, this make the Functor non-copyable which is required
  // by VTKm infrastructure (e.g. ArrayHandleTransform.)
  SeedType Seed;
}; // class PhiloxFunctor
} // namespace detail
 
class VTKM_ALWAYS_EXPORT ArrayHandleRandomUniformBits
  : public vtkm::cont::ArrayHandleImplicit<detail::PhiloxFunctor>
{
public:
  using SeedType = vtkm::Vec<vtkm::UInt32, 1>;
 
  VTKM_ARRAY_HANDLE_SUBCLASS_NT(ArrayHandleRandomUniformBits,
                                (vtkm::cont::ArrayHandleImplicit<detail::PhiloxFunctor>));
 
  explicit ArrayHandleRandomUniformBits(vtkm::Id length, SeedType seed = { std::random_device{}() })
    : Superclass(detail::PhiloxFunctor(seed), length)
  {
  }
}; // class ArrayHandleRandomUniformBits
}
} // namespace vtkm::cont
 
//=============================================================================
// Specializations of serialization related classes
 
namespace vtkm
{
namespace cont
{
}
} // namespace vtkm::cont
#endif //vtk_m_cont_ArrayHandleRandomUniformBits_h