Add some documentation on how ConnectivityExplicit::GetIndices works.

This commit is contained in:
Kenneth Moreland 2015-08-14 12:01:52 -06:00
parent 6598b296a6
commit 07ca62e2af

@ -76,6 +76,11 @@ public:
typedef vtkm::exec::internal::VecFromPortal<ConnectivityPortalType>
IndicesType;
/// Returns a Vec-like object containing the indices for the given index.
/// The object returned is not an actual array, but rather an object that
/// loads the indices lazily out of the connectivity array. This prevents
/// us from having to know the number of indices at compile time.
///
VTKM_EXEC_EXPORT
IndicesType GetIndices(vtkm::Id index) const
{