Skip to content

Commit

Permalink
Move detailed description into execution policy class
Browse files Browse the repository at this point in the history
Doxygen did not want to add the Execution Policy chapter into the Adiar module
since it only had the class (which had its own page). So, the information with
context was lost.
  • Loading branch information
SSoelvsten committed Oct 1, 2023
1 parent dab1618 commit 69360f6
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions src/adiar/exec_policy.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,23 @@ namespace adiar
/// \{

//////////////////////////////////////////////////////////////////////////////
/// \name Execution Policy
/// \brief Settings to dictate the execution of Adiar's algorithms.
///
/// Adiar's algorithms work very differently from other BDD implementations.
/// Hence, it makes use of multiple novel techniques to make it competitive
/// across the entire spectrum of BDD shapes and sizes.
/// across the entire spectrum of BDD shapes and sizes. These can be turned
/// on/off or tweaked by changing these settings.
///
/// An instance of the `exec_policy` class may be parsed to each algorithm to
/// change which or whether one of these techniques should be used throughout
/// execution. Most likely, you can entirely ignore this and just use the
/// default settings.
/// Most likely, you would want to apply all techniques (in a safe way) and so
/// you do not need to think about changing any of these.
///
/// \{

//////////////////////////////////////////////////////////////////////////////
/// \brief Collection of enum values to change the execution of Adiar's
/// algorithms.
/// For example, you can fix the `bdd_exists` to only use *internal* memory
/// and the *Nested Sweeping* framework as follows:
/// ```cpp
/// bdd_exists(exec_policy::access::Internal & exec_policy::quant::Nested,
/// f,
/// vars.rbegin(), vars.rend());
/// ```
//////////////////////////////////////////////////////////////////////////////
class exec_policy
{
Expand Down Expand Up @@ -279,9 +280,6 @@ namespace adiar
/// \}
//////////////////////////////////////////////////////////////////////////////

/// \}
//////////////////////////////////////////////////////////////////////////////

//////////////////////////////////////////////////////////////////////////////
/// \brief Operator overload to support lifting enum values to `exec_policy`.
//////////////////////////////////////////////////////////////////////////////
Expand Down

0 comments on commit 69360f6

Please sign in to comment.