WorkletReduceByKey.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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 viskores_worklet_WorkletReduceByKey_h
#define viskores_worklet_WorkletReduceByKey_h
 
#include <viskores/worklet/internal/WorkletBase.h>
 
#include <viskores/cont/arg/TransportTagArrayIn.h>
#include <viskores/cont/arg/TransportTagArrayInOut.h>
#include <viskores/cont/arg/TransportTagArrayOut.h>
#include <viskores/cont/arg/TransportTagKeyedValuesIn.h>
#include <viskores/cont/arg/TransportTagKeyedValuesInOut.h>
#include <viskores/cont/arg/TransportTagKeyedValuesOut.h>
#include <viskores/cont/arg/TransportTagKeysIn.h>
#include <viskores/cont/arg/TypeCheckTagArrayIn.h>
#include <viskores/cont/arg/TypeCheckTagArrayInOut.h>
#include <viskores/cont/arg/TypeCheckTagArrayOut.h>
#include <viskores/cont/arg/TypeCheckTagKeys.h>
 
#include <viskores/exec/internal/ReduceByKeyLookup.h>
 
#include <viskores/exec/arg/FetchTagArrayDirectIn.h>
#include <viskores/exec/arg/FetchTagArrayDirectInOut.h>
#include <viskores/exec/arg/FetchTagArrayDirectOut.h>
#include <viskores/exec/arg/FetchTagKeysIn.h>
#include <viskores/exec/arg/ThreadIndicesReduceByKey.h>
#include <viskores/exec/arg/ValueCount.h>
#include <viskores/worklet/DispatcherReduceByKey.h>
 
namespace viskores
{
namespace worklet
{
 
class WorkletReduceByKey : public viskores::worklet::internal::WorkletBase
{
public:
  template <typename Worklet>
  using Dispatcher = viskores::worklet::DispatcherReduceByKey<Worklet>;
 
 
  struct KeysIn : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagKeys;
    using TransportTag = viskores::cont::arg::TransportTagKeysIn;
    using FetchTag = viskores::exec::arg::FetchTagKeysIn;
  };
 
  struct ValuesIn : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayIn;
    using TransportTag = viskores::cont::arg::TransportTagKeyedValuesIn;
    using FetchTag = viskores::exec::arg::FetchTagArrayDirectIn;
  };
 
  struct ValuesInOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayInOut;
    using TransportTag = viskores::cont::arg::TransportTagKeyedValuesInOut;
    using FetchTag = viskores::exec::arg::FetchTagArrayDirectIn;
  };
 
  struct ValuesOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayOut;
    using TransportTag = viskores::cont::arg::TransportTagKeyedValuesOut;
    using FetchTag = viskores::exec::arg::FetchTagArrayDirectIn;
  };
 
  struct ReducedValuesOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayOut;
    using TransportTag = viskores::cont::arg::TransportTagArrayOut;
    using FetchTag = viskores::exec::arg::FetchTagArrayDirectOut;
  };
 
  struct ReducedValuesIn : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayIn;
    using TransportTag = viskores::cont::arg::TransportTagArrayIn;
    using FetchTag = viskores::exec::arg::FetchTagArrayDirectIn;
  };
 
  struct ReducedValuesInOut : viskores::cont::arg::ControlSignatureTagBase
  {
    using TypeCheckTag = viskores::cont::arg::TypeCheckTagArrayInOut;
    using TransportTag = viskores::cont::arg::TransportTagArrayInOut;
    using FetchTag = viskores::exec::arg::FetchTagArrayDirectInOut;
  };
 
#ifdef VISKORES_DOXYGEN_ONLY
  // These redeclarations of superclass features are for documentation purposes only.
 
  struct WholeArrayIn : viskores::worklet::internal::WorkletBase::WholeArrayIn
  {
  };
 
  struct WholeArrayOut : viskores::worklet::internal::WorkletBase::WholeArrayOut
  {
  };
 
  struct WholeArrayInOut : viskores::worklet::internal::WorkletBase::WholeArrayInOut
  {
  };
 
  struct AtomicArrayInOut : viskores::worklet::internal::WorkletBase::AtomicArrayInOut
  {
  };
 
  template <typename VisitTopology = Cell, typename IncidentTopology = Point>
  struct WholeCellSetIn
    : viskores::worklet::internal::WorkletBase::WholeCellSetIn<VisitTopology, IncidentTopology>
  {
  };
 
  struct ExecObject : viskores::worklet::internal::WorkletBase::ExecObject
  {
  };
#endif
 
 
 
#ifdef VISKORES_DOXYGEN_ONLY
  // These redeclarations of superclass features are for documentation purposes only.
 
  struct _1 : viskores::worklet::internal::WorkletBase::_1
  {
  };
#endif
 
  struct ValueCount : viskores::exec::arg::ValueCount
  {
  };
 
#ifdef VISKORES_DOXYGEN_ONLY
  // These redeclarations of superclass features are for documentation purposes only.
 
  struct WorkIndex : viskores::worklet::internal::WorkletBase::WorkIndex
  {
  };
 
  struct VisitIndex : viskores::worklet::internal::WorkletBase::VisitIndex
  {
  };
 
  struct InputIndex : viskores::worklet::internal::WorkletBase::InputIndex
  {
  };
 
  struct OutputIndex : viskores::worklet::internal::WorkletBase::OutputIndex
  {
  };
 
  struct ThreadIndices : viskores::worklet::internal::WorkletBase::ThreadIndices
  {
  };
 
  struct Device : viskores::worklet::internal::WorkletBase::Device
  {
  };
#endif
 
 
  VISKORES_SUPPRESS_EXEC_WARNINGS
  template <typename OutToInArrayType,
            typename VisitArrayType,
            typename ThreadToOutArrayType,
            typename InputDomainType>
  VISKORES_EXEC viskores::exec::arg::ThreadIndicesReduceByKey GetThreadIndices(
    viskores::Id threadIndex,
    const OutToInArrayType& outToIn,
    const VisitArrayType& visit,
    const ThreadToOutArrayType& threadToOut,
    const InputDomainType& inputDomain) const
  {
    const viskores::Id outIndex = threadToOut.Get(threadIndex);
    return viskores::exec::arg::ThreadIndicesReduceByKey(
      threadIndex, outToIn.Get(outIndex), visit.Get(outIndex), outIndex, inputDomain);
  }
};
}
} // namespace viskores::worklet
 
#endif //viskores_worklet_WorkletReduceByKey_h