VTK-m  1.8
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
vtkm::cont::PartitionedDataSet Class Reference

#include <PartitionedDataSet.h>

Public Types

using iterator = typename StorageVec::iterator
 
using const_iterator = typename StorageVec::const_iterator
 
using value_type = typename StorageVec::value_type
 
using reference = typename StorageVec::reference
 
using const_reference = typename StorageVec::const_reference
 

Public Member Functions

VTKM_CONT PartitionedDataSet (const vtkm::cont::DataSet &ds)
 create a new PartitionedDataSet containng a single DataSet ds More...
 
VTKM_CONT PartitionedDataSet (const vtkm::cont::PartitionedDataSet &src)
 create a new PartitionedDataSet with the existing one src More...
 
VTKM_CONT PartitionedDataSet (const std::vector< vtkm::cont::DataSet > &partitions)
 create a new PartitionedDataSet with a DataSet vector partitions. More...
 
VTKM_CONT PartitionedDataSet (vtkm::Id size)
 create a new PartitionedDataSet with the capacity set to be size More...
 
VTKM_CONT PartitionedDataSet ()
 
VTKM_CONT PartitionedDataSetoperator= (const vtkm::cont::PartitionedDataSet &src)
 
VTKM_CONT ~PartitionedDataSet ()
 
VTKM_CONT vtkm::cont::Field GetField (const std::string &field_name, int partition_index) const
 get the field field_name from partition partition_index More...
 
VTKM_CONT vtkm::Id GetNumberOfPartitions () const
 
const VTKM_CONT vtkm::cont::DataSetGetPartition (vtkm::Id partId) const
 
const VTKM_CONT std::vector< vtkm::cont::DataSet > & GetPartitions () const
 
VTKM_CONT void AppendPartition (const vtkm::cont::DataSet &ds)
 add DataSet ds to the end of the contained DataSet vector More...
 
VTKM_CONT void InsertPartition (vtkm::Id index, const vtkm::cont::DataSet &ds)
 add DataSet ds to position index of the contained DataSet vector More...
 
VTKM_CONT void ReplacePartition (vtkm::Id index, const vtkm::cont::DataSet &ds)
 replace the index positioned element of the contained DataSet vector with ds More...
 
VTKM_CONT void AppendPartitions (const std::vector< vtkm::cont::DataSet > &partitions)
 append the DataSet vector "partitions" to the end of the contained one More...
 
VTKM_CONT void PrintSummary (std::ostream &stream) const
 
VTKM_CONT iterator begin () noexcept
 API to support range-based for loops on partitions. More...
 
VTKM_CONT iterator end () noexcept
 
VTKM_CONT const_iterator begin () const noexcept
 
VTKM_CONT const_iterator end () const noexcept
 
VTKM_CONT const_iterator cbegin () const noexcept
 
VTKM_CONT const_iterator cend () const noexcept
 

Private Types

using StorageVec = std::vector< vtkm::cont::DataSet >
 

Private Attributes

std::vector< vtkm::cont::DataSetPartitions
 

Member Typedef Documentation

◆ const_iterator

using vtkm::cont::PartitionedDataSet::const_iterator = typename StorageVec::const_iterator

◆ const_reference

using vtkm::cont::PartitionedDataSet::const_reference = typename StorageVec::const_reference

◆ iterator

using vtkm::cont::PartitionedDataSet::iterator = typename StorageVec::iterator

◆ reference

using vtkm::cont::PartitionedDataSet::reference = typename StorageVec::reference

◆ StorageVec

◆ value_type

using vtkm::cont::PartitionedDataSet::value_type = typename StorageVec::value_type

Constructor & Destructor Documentation

◆ PartitionedDataSet() [1/5]

VTKM_CONT vtkm::cont::PartitionedDataSet::PartitionedDataSet ( const vtkm::cont::DataSet ds)

create a new PartitionedDataSet containng a single DataSet ds

◆ PartitionedDataSet() [2/5]

VTKM_CONT vtkm::cont::PartitionedDataSet::PartitionedDataSet ( const vtkm::cont::PartitionedDataSet src)

create a new PartitionedDataSet with the existing one src

◆ PartitionedDataSet() [3/5]

VTKM_CONT vtkm::cont::PartitionedDataSet::PartitionedDataSet ( const std::vector< vtkm::cont::DataSet > &  partitions)
explicit

create a new PartitionedDataSet with a DataSet vector partitions.

◆ PartitionedDataSet() [4/5]

VTKM_CONT vtkm::cont::PartitionedDataSet::PartitionedDataSet ( vtkm::Id  size)
explicit

create a new PartitionedDataSet with the capacity set to be size

◆ PartitionedDataSet() [5/5]

VTKM_CONT vtkm::cont::PartitionedDataSet::PartitionedDataSet ( )

◆ ~PartitionedDataSet()

VTKM_CONT vtkm::cont::PartitionedDataSet::~PartitionedDataSet ( )

Member Function Documentation

◆ AppendPartition()

VTKM_CONT void vtkm::cont::PartitionedDataSet::AppendPartition ( const vtkm::cont::DataSet ds)

add DataSet ds to the end of the contained DataSet vector

◆ AppendPartitions()

VTKM_CONT void vtkm::cont::PartitionedDataSet::AppendPartitions ( const std::vector< vtkm::cont::DataSet > &  partitions)

append the DataSet vector "partitions" to the end of the contained one

◆ begin() [1/2]

VTKM_CONT const_iterator vtkm::cont::PartitionedDataSet::begin ( ) const
inlinenoexcept

◆ begin() [2/2]

VTKM_CONT iterator vtkm::cont::PartitionedDataSet::begin ( )
inlinenoexcept

API to support range-based for loops on partitions.

◆ cbegin()

VTKM_CONT const_iterator vtkm::cont::PartitionedDataSet::cbegin ( ) const
inlinenoexcept

◆ cend()

VTKM_CONT const_iterator vtkm::cont::PartitionedDataSet::cend ( ) const
inlinenoexcept

◆ end() [1/2]

VTKM_CONT const_iterator vtkm::cont::PartitionedDataSet::end ( ) const
inlinenoexcept

◆ end() [2/2]

VTKM_CONT iterator vtkm::cont::PartitionedDataSet::end ( )
inlinenoexcept

◆ GetField()

VTKM_CONT vtkm::cont::Field vtkm::cont::PartitionedDataSet::GetField ( const std::string &  field_name,
int  partition_index 
) const

get the field field_name from partition partition_index

◆ GetNumberOfPartitions()

VTKM_CONT vtkm::Id vtkm::cont::PartitionedDataSet::GetNumberOfPartitions ( ) const

◆ GetPartition()

const VTKM_CONT vtkm::cont::DataSet& vtkm::cont::PartitionedDataSet::GetPartition ( vtkm::Id  partId) const

◆ GetPartitions()

const VTKM_CONT std::vector<vtkm::cont::DataSet>& vtkm::cont::PartitionedDataSet::GetPartitions ( ) const

◆ InsertPartition()

VTKM_CONT void vtkm::cont::PartitionedDataSet::InsertPartition ( vtkm::Id  index,
const vtkm::cont::DataSet ds 
)

add DataSet ds to position index of the contained DataSet vector

◆ operator=()

VTKM_CONT PartitionedDataSet& vtkm::cont::PartitionedDataSet::operator= ( const vtkm::cont::PartitionedDataSet src)

◆ PrintSummary()

VTKM_CONT void vtkm::cont::PartitionedDataSet::PrintSummary ( std::ostream &  stream) const

◆ ReplacePartition()

VTKM_CONT void vtkm::cont::PartitionedDataSet::ReplacePartition ( vtkm::Id  index,
const vtkm::cont::DataSet ds 
)

replace the index positioned element of the contained DataSet vector with ds

Member Data Documentation

◆ Partitions

std::vector<vtkm::cont::DataSet> vtkm::cont::PartitionedDataSet::Partitions
private

The documentation for this class was generated from the following file: