mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-20 11:05:44 +00:00
21823500c3
After a talk with Robert Maynard, we decided to change the name ArrayContainerControl to Storage. There are several reasons for this change. 1. The name ArrayContainerControl is unwieldy. It is long, hard for humans to parse, and makes for long lines and wraparound. It is also hard to distinguish from other names like ArrayHandleFoo and ArrayExecutionManager. 2. The word container is getting overloaded. For example, there is a SimplePolymorphicContainer. Container is being used for an object that literally acts like a container for data. This class really manages data. 3. The data does not necessarily have to be on the control side. Implicit containers store the data nowhere. Derivative containers might have all the real data on the execution side. It is possible in the future to have storage on the execution environment instead of the control (think interfacing with a simulator on the GPU). Storage is not a perfect word (what does implicit storage really mean?), but its the best English word we came up with.
148 lines
4.3 KiB
C++
148 lines
4.3 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 2014 Sandia Corporation.
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014. Los Alamos National Security
|
|
//
|
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
// 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_cont_ArrayHandleCounting_h
|
|
#define vtk_m_cont_ArrayHandleCounting_h
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/StorageImplicit.h>
|
|
|
|
#include <vtkm/cont/internal/IteratorFromArrayPortal.h>
|
|
|
|
namespace vtkm {
|
|
namespace cont {
|
|
|
|
namespace internal {
|
|
|
|
/// \brief An implicit array portal that returns an counting value.
|
|
template <class CountingValueType>
|
|
class ArrayPortalCounting
|
|
{
|
|
public:
|
|
typedef CountingValueType ValueType;
|
|
|
|
VTKM_EXEC_CONT_EXPORT
|
|
ArrayPortalCounting() :
|
|
StartingValue(),
|
|
NumberOfValues(0)
|
|
{ }
|
|
|
|
VTKM_EXEC_CONT_EXPORT
|
|
ArrayPortalCounting(ValueType startingValue, vtkm::Id numValues) :
|
|
StartingValue(startingValue),
|
|
NumberOfValues(numValues)
|
|
{ }
|
|
|
|
template<typename OtherValueType>
|
|
VTKM_EXEC_CONT_EXPORT
|
|
ArrayPortalCounting(const ArrayPortalCounting<OtherValueType> &src)
|
|
: StartingValue(src.StartingValue),
|
|
NumberOfValues(src.NumberOfValues)
|
|
{ }
|
|
|
|
template<typename OtherValueType>
|
|
VTKM_EXEC_CONT_EXPORT
|
|
ArrayPortalCounting<ValueType> &operator=(
|
|
const ArrayPortalCounting<OtherValueType> &src)
|
|
{
|
|
this->StartingValue = src.StartingValue;
|
|
this->NumberOfValues = src.NumberOfValues;
|
|
return *this;
|
|
}
|
|
|
|
VTKM_EXEC_CONT_EXPORT
|
|
vtkm::Id GetNumberOfValues() const { return this->NumberOfValues; }
|
|
|
|
VTKM_EXEC_CONT_EXPORT
|
|
ValueType Get(vtkm::Id index) const { return StartingValue+ValueType(index); }
|
|
|
|
typedef vtkm::cont::internal::IteratorFromArrayPortal<
|
|
ArrayPortalCounting < CountingValueType> > IteratorType;
|
|
|
|
VTKM_CONT_EXPORT
|
|
IteratorType GetIteratorBegin() const
|
|
{
|
|
return IteratorType(*this);
|
|
}
|
|
|
|
VTKM_CONT_EXPORT
|
|
IteratorType GetIteratorEnd() const
|
|
{
|
|
return IteratorType(*this, this->NumberOfValues);
|
|
}
|
|
|
|
private:
|
|
ValueType StartingValue;
|
|
vtkm::Id NumberOfValues;
|
|
};
|
|
|
|
/// A convenience class that provides a typedef to the appropriate tag for
|
|
/// a counting storage.
|
|
template<typename ConstantValueType>
|
|
struct ArrayHandleCountingTraits
|
|
{
|
|
typedef vtkm::cont::StorageTagImplicit<
|
|
vtkm::cont::internal::ArrayPortalCounting<ConstantValueType> > Tag;
|
|
};
|
|
|
|
} // namespace internal
|
|
|
|
/// ArrayHandleCountings is a specialization of ArrayHandle. By default it
|
|
/// contains a increment value, that is increment for each step between zero
|
|
/// and the passed in length
|
|
template <typename CountingValueType>
|
|
class ArrayHandleCounting
|
|
: public vtkm::cont::ArrayHandle <
|
|
CountingValueType,
|
|
typename internal::ArrayHandleCountingTraits<CountingValueType>::Tag
|
|
>
|
|
{
|
|
typedef vtkm::cont::ArrayHandle <
|
|
CountingValueType,
|
|
typename internal::ArrayHandleCountingTraits<CountingValueType>::Tag
|
|
> Superclass;
|
|
public:
|
|
|
|
VTKM_CONT_EXPORT
|
|
ArrayHandleCounting(CountingValueType startingValue, vtkm::Id length)
|
|
:Superclass(typename Superclass::PortalConstControl(startingValue, length))
|
|
{
|
|
}
|
|
|
|
VTKM_CONT_EXPORT
|
|
ArrayHandleCounting():Superclass() {}
|
|
};
|
|
|
|
/// A convenience function for creating an ArrayHandleCounting. It takes the
|
|
/// value to start counting from and and the number of times to increment.
|
|
template<typename CountingValueType>
|
|
VTKM_CONT_EXPORT
|
|
vtkm::cont::ArrayHandleCounting<CountingValueType>
|
|
make_ArrayHandleCounting(CountingValueType startingValue,
|
|
vtkm::Id length)
|
|
{
|
|
return vtkm::cont::ArrayHandleCounting<CountingValueType>(startingValue,
|
|
length);
|
|
}
|
|
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_ArrayHandleCounting_h
|