diff --git a/doc/gen/mainpage.md b/doc/gen/mainpage.md index 96ee9214..f73886f0 100644 --- a/doc/gen/mainpage.md +++ b/doc/gen/mainpage.md @@ -29,16 +29,16 @@ In summary, the general way to use an Iguana algorithm is as follows; see exampl - Tip: you may use `iguana::AlgorithmSequence` to help run a _sequence_ of algorithms 2. Check each algorithm configuration, and [adjust it if you prefer](#secConfiguring) 3. Start each algorithm, which "locks in" its configuration: - - call `Start(banklist)` if you use [**the HIPO API**](https://github.com/gavalian/hipo) and [Common Functions](#secCommon) - - call `Start()` otherwise, _i.e._, if you use [Action Functions](#secAction) + - call iguana::Algorithm::Start(hipo::banklist&) if you use [**the HIPO API**](https://github.com/gavalian/hipo) and [Common Functions](#secCommon) + - call iguana::Algorithm::Start() otherwise, _i.e._, if you use [Action Functions](#secAction) 4. In the event loop, run the algorithm: - - call `Run(...)` if you use Common Functions + - call iguana::Algorithm::Run(hipo::banklist&) const if you use Common Functions - call the Action Function(s) otherwise 5. Proceed with your analysis - - if you called `Run(...)`, the banks will be filtered, transformed, and/or created + - if you called iguana::Algorithm::Run(hipo::banklist&) const, the banks will be filtered, transformed, and/or created - if you called action functions, you will need to handle their output yourself - in either case, see [guidance on how to run algorithms](#secRunning) for more details -6. After your event loop, stop each algorithm by calling `Stop()` +6. After your event loop, stop each algorithm by calling iguana::Algorithm::Stop() Please let the maintainers know if your use case is not covered in any examples or if you need any help. @@ -84,13 +84,13 @@ All algorithms have the following **Common Functions**, which may be used in ana | Common Functions || | --- | --- | -| `iguana::Algorithm::Start` | To be called before event processing | -| `iguana::Algorithm::Run` | To be called for every event | -| `iguana::Algorithm::Stop` | To be called after event processing | +| iguana::Algorithm::Start(hipo::banklist&) | To be called before event processing | +| iguana::Algorithm::Run(hipo::banklist&) const | To be called for every event | +| iguana::Algorithm::Stop() | To be called after event processing | The algorithms are implemented in C++ classes which inherit from the base class `iguana::Algorithm`; these three class methods are overridden in each algorithm. -The `iguana::Algorithm::Run` function should be called on every event; the general consequence, that is, how the user should handle the algorithm's results, depends on the +The iguana::Algorithm::Run(hipo::banklist&) const function should be called on every event; the general consequence, that is, how the user should handle the algorithm's results, depends on the algorithm type:
**Creator** | Creator-type algorithms will simply create a new `hipo::bank` object, appending it to the end of the input `hipo::banklist`. An initial version is created upon calling -`iguana::Algorithm::Start`, so that you may begin to reference it; it is helpful to +iguana::Algorithm::Start(hipo::banklist&), so that you may begin to reference it; it is helpful to use `hipo::getBanklistIndex` (see [the examples for details](#secExample)). |