vtkAffineImplicitBackend< ValueType > Struct Template Reference

A utility structure serving as a backend for affine (as a function of the index) implicit arrays. More...

#include <vtkAffineImplicitBackend.h>

Public Member Functions
	vtkAffineImplicitBackend (ValueType slope, ValueType intercept)
	A non-trivially constructible constructor.
ValueType	operator() (vtkIdType index) const
	The main call method for the backend.

Public Attributes
ValueType	Slope
	The slope of the affine function on the indices.
ValueType	Intercept
	The value of the affine function at index 0.

Detailed Description

template<typename ValueType>
struct vtkAffineImplicitBackend< ValueType >

A utility structure serving as a backend for affine (as a function of the index) implicit arrays.

This structure can be classified as a closure and can be called using syntax similar to a function call.

At construction it takes two parameters: the slope of the map and the intercept. It returns a value calculated as:

value = slope * index + intercept

An example of potential usage in a vtkImplicitArray

double slope = some_number;
double intercept = some_other_number;
vtkNew<vtkImplicitArray<vtkAffineImplicitBackend<double>>> affineArray;
affineArray->SetBackend(std::make_shared<vtkAffineImplicitBackend<double>>(slope, intercept));
affineArray->SetNumberOfTuples(however_many_you_want);
affineArray->SetNumberOfComponents(whatever_youd_like);
double value = affineArray->GetTypedComponent(index_in_tuple_range, index_in_component_range);

Definition at line 37 of file vtkAffineImplicitBackend.h.

Constructor & Destructor Documentation

vtkAffineImplicitBackend()

template<typename ValueType >

vtkAffineImplicitBackend< ValueType >::vtkAffineImplicitBackend	(	ValueType	slope,
		ValueType	intercept
	)

A non-trivially constructible constructor.

Parameters

slope	the slope of the affine function
intercept	the intercept value at the origin (i.e. the value at 0)

Member Function Documentation

operator()()

template<typename ValueType >

ValueType vtkAffineImplicitBackend< ValueType >::operator()

(

vtkIdType

index

)

const

The main call method for the backend.

Parameters

index

the index at which one wished to evaluate the backend

Returns

the affinely computed value

Member Data Documentation

Slope

template<typename ValueType >

ValueType vtkAffineImplicitBackend< ValueType >::Slope

The slope of the affine function on the indices.

Definition at line 58 of file vtkAffineImplicitBackend.h.

Intercept

template<typename ValueType >

ValueType vtkAffineImplicitBackend< ValueType >::Intercept

The value of the affine function at index 0.

Definition at line 62 of file vtkAffineImplicitBackend.h.

---

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

• Common/Core/vtkAffineImplicitBackend.h