LinearCombinator< T > Class Template Reference
Performs linear combination of templated terms. More...
Detailed Description
template<typename T>
class LinearCombinator< T >
Performs linear combination of templated terms.
This module returns a linear combination of objects e.g. if it is called with (v1, v2, v3, ...) and (a, b, c, ...) it will return a*v1 + b*v2 + c*v3 + ....
Integration dimension
This module requires 0 phase-space point.
Parameters
| Name | Type | Description |
|---|---|---|
coefficients | vector(double) | List of the coefficients multiplying each term in the linear combination (must have same size as inputs). |
Inputs
| Name | Type | Description |
|---|---|---|
inputs | vector(T) | List of terms used in the linear operation. |
Outputs
| Name | Type | Description |
|---|---|---|
output | T | Object resulting form the linear combination. |
Definition at line 56 of file LinearCombinator.cc.
Inheritance diagram for LinearCombinator< T >:
Public Member Functions | |
| LinearCombinator (PoolPtr pool, const ParameterSet ¶meters) | |
| virtual Status | work () override |
| Main function. More... | |
 Public Member Functions inherited from Module | |
| Module (PoolPtr pool, const std::string &name) | |
| Constructor. More... | |
| virtual void | configure () |
| Called once at the beginning of the job. | |
| virtual void | beginIntegration () |
| Called once at the beginning of the integration. | |
| virtual void | beginPoint () |
| Called once when a new PS point is started. More... | |
| virtual void | beginLoop () |
| Called once at the beginning of a loop. More... | |
| virtual void | endLoop () |
| Called once at the end of a loop. More... | |
| virtual void | endPoint () |
| Called once when a PS point is finished. More... | |
| virtual void | endIntegration () |
| Called once at the end of the integration. | |
| virtual void | finish () |
| Called once at the end of the job. | |
| virtual std::string | name () const final |
Additional Inherited Members | |
| Public Types inherited from Module | |
| enum | Status : std::int8_t { OK, NEXT, ABORT } |
| Static Public Member Functions inherited from Module | |
| static std::string | statusToString (const Status &status) |
| static bool | is_virtual_module (const std::string &name) |
| Test if a given name correspond to a virtual module. More... | |
| Protected Member Functions inherited from Module | |
| template<typename T , typename... Args> | |
| std::shared_ptr< T > | produce (const std::string &name, Args... args) |
| Add a new output to the module. More... | |
| template<typename T > | |
| Value< T > | get (const std::string &module, const std::string &name) |
| template<typename T > | |
| Value< T > | get (const InputTag &tag) |
| Protected Attributes inherited from Module | |
| PoolPtr | m_pool |
Member Function Documentation
◆ work()
template<typename T >
|
inlineoverridevirtual |
Main function.
This method is called for each integration step. The module's logic and work happen here.
You'll usually want to override this function if you want your module to perform some task.
Reimplemented from Module.
Definition at line 78 of file LinearCombinator.cc.
The documentation for this class was generated from the following file:
- modules/LinearCombinator.cc
