Line data    Source code

       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6           0 : namespace ah::protocols {
       7             : /*!
       8             :  * \brief A protocol for a callback to a horizon find.
       9             :  *
      10             :  * \details Can be used in either `horizon_find_callbacks` or
      11             :  * `horizon_find_failure_callbacks` in the `ah::protocols::HorizonMetavars`.
      12             :  *
      13             :  * A struct conforming to the this protocol must have
      14             :  *
      15             :  * - An apply function with the signature in the example
      16             :  *
      17             :  * A struct conforming to this protocol can also optionally specify
      18             :  *
      19             :  * - a type alias `const_global_cache_tags` that holds global cache tags.
      20             :  *
      21             :  * \snippet Helpers/ParallelAlgorithms/ApparentHorizonFinder/TestHelpers.hpp HorizonFindCallback
      22             :  */
      23           1 : struct Callback {
      24             :   template <typename ConformingType>
      25           0 :   struct test {};
      26             : };
      27             : }  // namespace ah::protocols