Skip to content

[RF] Documentation of RooAbsReal::getValues is broken #9523

@hageboeck

Description

@hageboeck
  • A rebase or similar apparently cut the documentation in two, and a stray sentence now leads the documentation of the second overload.
  • The first overload has no documentation at all ...

Please make it a habit immediately write a good docstring in the same commit where the interface is fixed defined.

/// \deprecated getValBatch() has been removed in favour of the faster getValues(). If your code is affected
/// by this change, please consult the release notes for ROOT 6.24 for guidance on how to make this transition.
/// https://root.cern/doc/v624/release-notes.html
#ifndef R__MACOSX
virtual RooSpan<const double> getValBatch(std::size_t /*begin*/, std::size_t /*maxSize*/, const RooArgSet* /*normSet*/ = nullptr) = delete;
#else
//AppleClang in MacOS10.14 has a linker bug and fails to link programs that create objects of classes containing virtual deleted methods.
//This can be safely deleted when MacOS10.14 is no longer supported by ROOT. See https://reviews.llvm.org/D37830
virtual RooSpan<const double> getValBatch(std::size_t /*begin*/, std::size_t /*maxSize*/, const RooArgSet* /*normSet*/ = nullptr) final {
throw std::logic_error("Deprecated getValBatch() has been removed in favour of the faster getValues(). If your code is affected by this change, please consult the release notes for ROOT 6.24 for guidance on how to make this transition. https://root.cern/doc/v624/release-notes.html");
}
#endif
/// by this change, please consult the release notes for ROOT 6.24 for guidance on how to make this transition.
virtual RooSpan<const double> getValues(RooBatchCompute::RunContext& evalData, const RooArgSet* normSet = nullptr) const;

https://root.cern.ch/doc/master/classRooAbsReal.html#a3f4185c14daa089c29ae3ba1e90b5235

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions