vtkBatch is a simple structure that holds a begin and end id. More...

#include <vtkBatch.h>

Public Member Functions
	vtkBatch ()=default

	~vtkBatch ()=default

Public Attributes
vtkIdType	BeginId

vtkIdType	EndId

TBatchData	Data

Detailed Description

template<typename TBatchData>
class vtkBatch< TBatchData >

vtkBatch is a simple structure that holds a begin and end id.

vtkBatch is a simple structure that holds a begin and end id of an element, e.g. cell or point. vtkBatches is a vector with vtkBatch objects. vtkBatch has a template parameter that is used to store additional information for each batch.

The concept of batches is useful because it can be used to avoid spending memory by saving information for each element of a batch, e.g. number of output cells/points. Instead, you can save the aggregate information for all elements in the batch.

Aside from saving memory, they are particularly useful because you can trim batches that should be skipped in a follow-up step. For example, if you are processing cells, and some batches of cells are not generating any output, you can trim those batches.

Trimming batches is useful both for avoiding extra computation and also improving load balancing in parallel processing.

See also: vtkTableBasedClipDataSet, vtkExtractCells, vtkStaticFaceHashLinksTemplate, vtkPolyDataPlaneCutter, vtkPolyDataPlaneClipper, vtkStructuredDataPlaneCutter

Definition at line 40 of file vtkBatch.h.