Method

NumCosmoMathFunctionSampleSetiter_end

Declaration [src]

void
ncm_function_sample_set_iter_end (
  NcmFunctionSampleSet* fss,
  NcmFunctionSampleSetIter** iter_out
)

Description [src]

Positions an iterator at the last sample in fss. If fss is empty, the iterator will be invalid. When iter_out points to a NULL pointer the callee allocates a new iterator that must be freed with ncm_function_sample_set_iter_free(). When iter_out points to an already-allocated iterator (e.g. a stack variable) no allocation occurs and no free is required.

Parameters

iter_out

Type: NcmFunctionSampleSetIter

Iterator set to the last sample; if *iter_out is NULL a new iterator is heap-allocated, otherwise the existing memory is reused.

The argument will be set by the function.
The caller of the method takes ownership of the returned data, and is responsible for freeing it.