kokkos / kokkos-core-wiki

2 stars 44 forks source link

Update regarding new `set_scratch_size` semantics #491

Closed cartoonist closed 7 months ago

cartoonist commented 7 months ago

As far as I know, set_scratch_size member function modifies the instance. However, the documentation, in HierarchicalParallelism.md section, refers to old behaviour:

Note like previously discussed, the setter function does not modify the instance it is called on, but returns a copy of the policy object with adjusted scratch size request.

I couldn't find where exactly it was "previously discussed" though.

dalg24 commented 7 months ago

You're correct. We overlooked the documentation when we changed it (in https://github.com/kokkos/kokkos/pull/4918). Thank you for reporting the discrepancy.